Skip to content

Conversation

@structwafel
Copy link
Contributor

Made ./static-serve/README.md a symlink, such that in crates.io the readme is consistent with the workspace readme.

This is something atuin also does:

setting up a "relative" readme in cargo is possible, however then the #![doc.. relative path doesn't work anymore.

[package]
name = "static-serve"
readme = "../README.md"  #  <-- work but no #![doc support

@paolobarbolini
Copy link
Member

Suddenly axum decided to go do something else 😆

@structwafel
Copy link
Contributor Author

structwafel commented Sep 19, 2025

I was today years old where I learned that it will run all readme code if you include it in the docs.

The old readme also just ignored it, So doing the same here.

@structwafel structwafel changed the title (docs) remove README duplication via symlink docs remove README duplication via symlink Sep 19, 2025
Copy link
Member

@ThinkerDreamer ThinkerDreamer left a comment

Choose a reason for hiding this comment

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

Hey @structwafel , thanks! Looks good. We can squash these into one commit with docs: at the beginning.

@structwafel
Copy link
Contributor Author

Done! @ThinkerDreamer
Need to step up my git game 3

@ThinkerDreamer ThinkerDreamer merged commit c11f5d5 into M4SS-Code:main Sep 25, 2025
7 checks passed
@structwafel structwafel deleted the docs/single-readme branch September 25, 2025 14:50
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