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

Add docs setup in CONTRIBUTING.md #88

Merged
merged 9 commits into from
Sep 15, 2023
Merged

Conversation

fabriziofs
Copy link
Collaborator

@fabriziofs fabriziofs commented Sep 14, 2023

📚 Description

Add documentation for CONTRIBUTING.md.

I'm also thinking about adding this documentation in a specific page inside the documentation itself, and in the CONTRIBUTING.md only add a reference to that page, what do you think 🤔

Closes #83

🔖 Changes

  • Add docs

✅ To-do list

  • Make sure that all the pipeline passes
  • Make sure to update the CHANGELOG.md to reflect the new feature or fix

Copy link
Member

@antonio-gg-dev antonio-gg-dev left a comment

Choose a reason for hiding this comment

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

It would be useful to add a link to the instructions for installing nvm on Linux and macOS https://github.com/nvm-sh/nvm#installing-and-updating and also for Windows https://github.com/coreybutler/nvm-windows#installation--upgrades.

I also believe it would be worthwhile to indicate that if they don't have the version we require in our .nvmrc, it's as simple as running nvm install, and to have yarn in that version of node all you need to do is run npm i -g yarn.

Lastly, I think I would add to the documentation that it's advisable to run yarn docs:build before creating the PR to ensure that the build works, as this step has certain checks like ensuring there are no dead links, etc.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@antonio-gg-dev
Copy link
Member

And I also think it would be very useful to indicate that our documentation is in the 'docs' and is created with VitePress, along with a link to its documentation https://vitepress.dev/ .

@fabriziofs
Copy link
Collaborator Author

@Tito-Kati I make some changes following your suggestions, can you take a look pls? If there's anything more to add/modify dot hesitate to point it out

Thank you!

@fabriziofs fabriziofs added the documentation Improvements or additions to documentation label Sep 15, 2023
Copy link
Member

@antonio-gg-dev antonio-gg-dev left a comment

Choose a reason for hiding this comment

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

Nice work!

@antonio-gg-dev antonio-gg-dev merged commit 8e5e050 into main Sep 15, 2023
7 checks passed
@antonio-gg-dev antonio-gg-dev deleted the docs-set-up-in-contributing branch September 15, 2023 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs setup in contributing
3 participants