docs: refresh READMEs#2165
Merged
Merged
Conversation
Mirko-von-Leipzig
added
documentation
bobbinth
reviewed
Jun 1, 2026
Contributor
There was a problem hiding this comment.
Ah - nice that we can move all of these into the .config directory. We should do something like this in other repos too.
sergerad
reviewed
Jun 1, 2026
sergerad
reviewed
Jun 1, 2026
sergerad
reviewed
Jun 1, 2026
sergerad
approved these changes
Jun 1, 2026
sergerad
left a comment
sergerad
left a comment
Collaborator
There was a problem hiding this comment.
Thanks this is better. Might as well fix the 404s for the miden-docs
bobbinth
approved these changes
Jun 2, 2026
Comment on lines
+8
to
+10
| [ci-badge]: https://github.com/0xMiden/node/actions/workflows/ci.yml/badge.svg | ||
| [ci-link]: https://github.com/0xMiden/node/actions/workflows/ci.yml | ||
| [developer-docs]: https://0xMiden.github.io/node/index.html |
Contributor
There was a problem hiding this comment.
Why break out these specific links like so?
Collaborator
Author
There was a problem hiding this comment.
The AI did it as part of a pass improving the legibility (shortening line length), and I didn't really mind enough to undo :) I can revert it?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates all READMEs for v0.15.
I've tried to standardize around:
This should reduce the churn overall, these are constantly outdated.
I've also introduced markdown formatting and linting - this currently only impacts the readme's and not the docs. I'll revisit the latter when I refresh these for v0.15.
We're also collecting dotfiles at a somewhat egregious pace, so I've moved them into
.config.