We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
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
As discussed on Slack, the documentation structure should be clear and intuitive, and not in large, hard-to-parse (for newcomers) files.
Our main issues are that:
With that in mind, following the pattern used by Node.js core (https://github.com/nodejs/node/tree/main/doc/contributing), we should break down our contributing guide into:
docs/ ├── README.md (navigation guide) ├── getting-started.md ├── code-style.md ├── writing-tests.md ├── adding-pages.md └── collaborator-guide.md ...
This will make the documentation more accessible and easier to maintain for both new contributors and collaborators.
The text was updated successfully, but these errors were encountered:
Strong +1 appreciate you for handling this!
Sorry, something went wrong.
+1
avivkeller
Successfully merging a pull request may close this issue.
As discussed on Slack, the documentation structure should be clear and intuitive, and not in large, hard-to-parse (for newcomers) files.
Our main issues are that:
With that in mind, following the pattern used by Node.js core (https://github.com/nodejs/node/tree/main/doc/contributing), we should break down our contributing guide into:
This will make the documentation more accessible and easier to maintain for both new contributors and collaborators.
The text was updated successfully, but these errors were encountered: