Skip to content

readme: add text fragments to features table, other tweaks#2171

Merged
thomas-zahner merged 11 commits into
lycheeverse:masterfrom
rina-forks:readme-text-frags
May 29, 2026
Merged

readme: add text fragments to features table, other tweaks#2171
thomas-zahner merged 11 commits into
lycheeverse:masterfrom
rina-forks:readme-text-frags

Conversation

@katrinafyi

@katrinafyi katrinafyi commented Apr 25, 2026

Copy link
Copy Markdown
Member

I wanted to add the new text fragments feature because I think it's a real distinguishing feature (thanks @cristiklein!).

While doing this, I also made some changes which should promote the information which people want to see (and better show off lychee).

  • Move Github actions section much earlier, since it's probably a very common use case.
  • Hide feature flag information in a details block.
  • Mention cargo binstall in pre-build binaries section.
  • Add subheadings in the feature table.
  • Reorder and group feature table using these subheadings.
  • Hyperlinks some ✔️ marks to lychee CLI arguments. I remember there was an issue that said they thought fragment checking was enabled by default because of the ✔️.

Uhh let me know what you think. I can slice and subtract things from this PR if you think they're too much.

See here for the rendered readme: https://github.com/rina-forks/lychee/tree/readme-text-frags#features

@cristiklein cristiklein left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm obviously biased, but I like this change. I assume that most people bumping into the README file are users and not developers, so getting quicker to usage is positive.

Nit-pick: The latest documentation for include-fragments is not deployed yet. Until then, clicking on the checkmarks might be a bit confusing.

@thomas-zahner thomas-zahner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you 🚀
I love the * May need configuration info :)

I agree with all your changes but noticed some inconsistencies with old links in the feature table. Could you adjust these?

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
katrinafyi and others added 3 commits May 28, 2026 20:41
Co-authored-by: Thomas Zahner <thomas.zahner@protonmail.ch>
and link to lychee docs instead of github issues
@thomas-zahner thomas-zahner merged commit 10d57b8 into lycheeverse:master May 29, 2026
7 checks passed
@mre mre mentioned this pull request May 29, 2026
@katrinafyi

Copy link
Copy Markdown
Member Author

Thanks for the review @thomas-zahner ! We should also merge lycheeverse/lycheeverse.github.io#152 to get the new --include-fragments docs.

@thomas-zahner

Copy link
Copy Markdown
Member

Oh right, thanks for reminding :)

This was referenced May 30, 2026
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.

3 participants