-
-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Contributing Guidelines for the Documentation Repository #14
Contributing Guidelines for the Documentation Repository #14
Conversation
Deploying with Cloudflare Pages
|
Reminder to self, should discuss how to document changes between minor and patch versions. |
Co-authored-by: sciwhiz12 <sciwhiz12@gmail.com>
@ChampionAsh5357, feel free to merge once you're okay with it. I'm not merging mostly because we still have that one unresolved comment, and I'm not sure if you want me to mark it as resolved or keep it unresolved as a note. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe an example of using tabs could also be provided?
…NeoForge-Docs into pages/contributing
42e572b
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, though we should look into the future into making the labels on those tabs be more human-readable.
For example, with the tabs currently in the example, they could be labelled as 20.2.68 and above
, 20.2.35 to 20.2.67
, and 20.2.0 to 20.2.34
, respectively. But this can be done at a later date; maybe even automated to some extent, perhaps as an MDX plugin I think.
That would be my assumption. We could also use that plugin to open tabs to the correct location depending on the chosen version as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good to me
You think my English writing practice would've caught this. Co-authored-by: Dennis C <xfacthd@gmx.de>
Co-authored-by: sciwhiz12 <sciwhiz12@gmail.com> Co-authored-by: Dennis C <xfacthd@gmx.de>
This defines the guidelines for contributing to this repo along with the style guide for markdown files. Additionally, this adds a
.node-version
file to use nvm and nvs with the correct version of Node.Preview URL: https://pr-14.neoforged-docs-previews.pages.dev