Skip to content

Polish docs and fix starchart - #5134

Open
AverWasTaken wants to merge 2 commits into
cabaletta:1.21.4from
AverWasTaken:redo-docs
Open

AverWasTaken wants to merge 2 commits into
cabaletta:1.21.4from
AverWasTaken:redo-docs

Conversation

@AverWasTaken

Copy link
Copy Markdown
Contributor

Polish docs and fix starchart

Branch: redo-docs -> 1.21.4


What this PR does

Cleans up the readme, usage, setup and features docs, and swaps the dead starchart.cc graph for star-history. Same content and same jokes, just easier to find stuff.

Why it should be merged

People struggle to find downloads, so the readme now leads with a quick start and a short download table, and there's a big box telling people to check releases before asking in the discord for a new version. Docs only, nothing in the code changes.

What changed

  • readme: rewritten. short intro and a link bar up top, quick start, one row per version in the download table (newest first, old ones in a dropdown), the badge wall moved into a dropdown at the bottom. dropped the MC version badges since they stopped at 1.21.3
  • star chart: starchart.cc broke after the stargazer api change (README.md Github Stars API Failure #5121), it just says rate limited now. star-history works without a token and has a dark mode
  • usage: commands grouped (going places, waypoints, mining/building, control, maintenance) instead of one big list
  • setup: version table goes up to 26.2 now and reads top to bottom, artifact flavors split into "which one you want" and "what the name means"
  • fixed stuff that was just wrong: schematica -> litematica, buildRepeatDistance/buildRepeatDirection -> buildRepeat/buildRepeatCount, bucket fall is 20 not 23, dead travis badge. pause, pickup, elytra and home weren't mentioned anywhere

Testing

checked every command and setting name against the code. you can preview it on my fork at https://github.com/AverWasTaken/barigo/tree/redo-docs if you fancy

@AverWasTaken
AverWasTaken force-pushed the redo-docs branch 2 times, most recently from b88e7c8 to efb8799 Compare September 23, 2026 05:16

@ZacSharp ZacSharp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commenting on the markdown diff is a bit messy, so I shoved everything for the readme into a single file comment. Let's see what works better.

Should probably just remove mentions of Impact without replacement because it's stuck on 1.16.5. (except when mentioning it to explain Baritones origins, that one might be fine)

#elytra has already been usable in the overworld for some time and next release it will also work on all platforms (no more native library), so mentions to platform support should be removed. #elytra supported still exists and works (it answers yes), but that's going to change at some point.

Comment thread README.md
Comment thread USAGE.md Outdated
Comment thread USAGE.md Outdated
Comment thread SETUP.md Outdated
Comment thread SETUP.md
Comment thread SETUP.md Outdated
same docs, same jokes, just less of a maze. the readme leads with a
quick start and a download table that's one short row per version,
newest first, with a big box telling people to check releases before
asking the discord for a new version. the badge wall lives in a
dropdown at the bottom now, minus the mc version badges that stopped
at 1.21.3. usage groups the commands instead of one giant list, and
setup's version table goes up to 26.2

starchart.cc broke when github locked down the stargazer api (cabaletta#5121),
star-history still works without a token and has a dark mode

also fixes stuff that was just wrong: schematica is litematica now,
buildRepeatDistance / buildRepeatDirection don't exist (buildRepeat
does), the bucket fall is 20 not 23, the travis badge was dead, and
pause / pickup / elytra / home weren't mentioned anywhere
@AverWasTaken

Copy link
Copy Markdown
Contributor Author

went through all of it:

  • badges are back up top, no more details tag. the version badges are your two (yellow 1.12.2 - 1.21.3, green 1.21.4 - 26.3). dropped the client integration ones and the tokei one, tokei.rs doesn't resolve anymore
  • 1.12.2 is a row in the table now, the 1.16.5 video bit is gone
  • impact is only left in the "used in impact since 4.4" origin line, the .b / .goto stuff and the impact/kami troubleshooting bits are gone or say "some clients" now
  • elytra doesn't say nether anymore, and elytra supported is out
  • dropped the old command migration lines
  • took the reset acceptableThrowawayItems suggestion. also the old text said plain reset resets everything, but it actually asks you to specify all, so that says reset all now
  • setup table is back to the wide one. only change there is 1.21.3 getting its own v1.12 column, it was lumped in with v1.11 before
  • flavors are one list now, each entry says when to use it
  • building mentions that the jars land in dist

squashed and rebased onto current 1.21.4 too

Comment thread README.md
Comment thread README.md

@ZacSharp ZacSharp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm kinda sure that while reading the rendered file I found something which probably doesn't work as stated (planned comment "Are you sure this works?" or similar), but I cannot find it again.

Comment thread USAGE.md Outdated
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@AverWasTaken

Copy link
Copy Markdown
Contributor Author

went through the new ones:

  • moved 1.21.1 and 1.21.3 into the older versions dropdown, main table is just 1.21.4 - 1.21.6 now
  • took the #wp list death wording, verified it against the code. #wp goal death sets it immediately if there's only one, otherwise it lists them to pick
  • not adding the badges badge lol
  • also fixed one while i was in there: right-clicking a bed makes a bed waypoint, not home (home only comes from sethome). might've been the thing you couldn't find again, not sure
  • lmk if you remember what the other broken thing was

@ZacSharp

Copy link
Copy Markdown
Collaborator

also fixed one while i was in there: right-clicking a bed makes a bed waypoint, not home (home only comes from sethome). might've been the thing you couldn't find again, not sure

Nailed it. That feature was completely broken at some point and I didn't know whether it was fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants