Open
Conversation
Contributor
Author
|
Another note: The website directory has a README that sort of explains how to develop it, but I did not find it very helpful + documenting it in the main Moonwave README makes it easier to access. |
Collaborator
|
If we're expanding the development guide this much, I think it's worth moving it all into a separate |
This guide should be for Moonwave specific information. `/docs` is a Docusaurus thing.
YetAnotherClown
requested changes
Mar 25, 2025
Collaborator
YetAnotherClown
left a comment
YetAnotherClown
left a comment
There was a problem hiding this comment.
Looks good so far, I'd just like to see the information presented to be more concise and better structure by splitting things up into sections and sub-sections.
Not relevant to Moonwave.
YetAnotherClown
added
documentation
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
2 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.
Elaborates a lot more on how to edit each part of Moonwave.
It is a bit repetitive to explain the usage of each feature in
## Key featuresas well as each individual section of## Building in Development and Contributing, though I think it is nice to have a quick recap on the use before delving into the development details. Additionally, the summaries in the latter section can be more technical.Referencing the official website twice might not be necessary, but I think it could reduce friction slightly.
The exclamation mark part drove me crazy so I think adding it would be nice, even if it will not affect most people. This is what I was facing in #170. Webpack sometimes gives a proper error for this, but when editing the Docusaurus plugin it was just telling me that it could not resolve the path.
Clown mentioned before that Cargo Insta is not required, but I do not see any way to test without it, so I think maybe it should not even say "recommended to use" and rather list it as a requirement.
I guess I should just say "You" since I know Clown will be the one reading this but it feels weird to use second person in a pull request.