Skip to content
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

Merged
merged 12 commits into from
Oct 11, 2023

Conversation

ChampionAsh5357
Copy link
Contributor

@ChampionAsh5357 ChampionAsh5357 commented Oct 2, 2023

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

@ChampionAsh5357 ChampionAsh5357 requested a review from a team October 2, 2023 17:28
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 2, 2023 17:30 Active
@neoforged-pages-deployments
Copy link

neoforged-pages-deployments bot commented Oct 2, 2023

Deploying with Cloudflare Pages

Name Result
Last commit: 8dbaf0e2c7a42622fe2e91a3f9da3df5031618ff
Status: ✅ Deploy successful!
Preview URL: https://f5e91439.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-14.neoforged-docs-previews.pages.dev

@ChampionAsh5357
Copy link
Contributor Author

Reminder to self, should discuss how to document changes between minor and patch versions.

@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 2, 2023 20:09 Active
src/pages/contributing.md Outdated Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 3, 2023 15:35 Active
src/pages/contributing.md Outdated Show resolved Hide resolved
src/pages/contributing.md Outdated Show resolved Hide resolved
src/pages/contributing.md Outdated Show resolved Hide resolved
src/pages/contributing.md Outdated Show resolved Hide resolved
src/pages/contributing.md Outdated Show resolved Hide resolved
src/pages/contributing.md Outdated Show resolved Hide resolved
src/pages/contributing.md Outdated Show resolved Hide resolved
Co-authored-by: sciwhiz12 <sciwhiz12@gmail.com>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 7, 2023 04:52 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 7, 2023 05:08 Active
sciwhiz12
sciwhiz12 previously approved these changes Oct 10, 2023
@sciwhiz12
Copy link
Member

@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.

Matyrobbrt
Matyrobbrt previously approved these changes Oct 10, 2023
Copy link
Member

@Matyrobbrt Matyrobbrt left a 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?

@ChampionAsh5357 ChampionAsh5357 dismissed stale reviews from Matyrobbrt and sciwhiz12 via 42e572b October 10, 2023 14:16
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 10, 2023 14:19 Active
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 10, 2023 18:24 Active
sciwhiz12
sciwhiz12 previously approved these changes Oct 10, 2023
Copy link
Member

@sciwhiz12 sciwhiz12 left a 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.

src/pages/contributing.md Outdated Show resolved Hide resolved
@ChampionAsh5357
Copy link
Contributor Author

Looks good to me, though we should look into the future into making the labels on those tabs be more human-readable.

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.

src/pages/contributing.mdx Show resolved Hide resolved
src/pages/contributing.mdx Show resolved Hide resolved
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 10, 2023 21:05 Active
XFactHD
XFactHD previously approved these changes Oct 10, 2023
Copy link
Member

@XFactHD XFactHD left a 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 :shipit:

src/pages/contributing.mdx Outdated Show resolved Hide resolved
You think my English writing practice would've caught this.

Co-authored-by: Dennis C <xfacthd@gmx.de>
@neoforged-pages-deployments neoforged-pages-deployments bot deployed to neoforged-docs-previews (Preview) October 10, 2023 22:00 Active
@sciwhiz12 sciwhiz12 requested a review from XFactHD October 11, 2023 08:49
@ChampionAsh5357 ChampionAsh5357 merged commit 13d5ad4 into neoforged:main Oct 11, 2023
1 check passed
srcres258 pushed a commit to srcres258/neo-doc that referenced this pull request Oct 12, 2023
Co-authored-by: sciwhiz12 <sciwhiz12@gmail.com>
Co-authored-by: Dennis C <xfacthd@gmx.de>
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.

6 participants