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

docs: CONTRIBUTING.md Development Tips table of contents has strange scope #714

Open
AmirNaghibi opened this issue Oct 29, 2020 · 2 comments
Labels
type: docs 📖 documentation is king

Comments

@AmirNaghibi
Copy link
Member

Describe the issue
A clear and concise description of what the issue is.

Development Tips section in CONTRIBUTING.md comes after Guidelines section but it includes a table of contents starting with the Guideline section.

Additional context
Add any other context about the problem here, such as screenshots and links to
relevant documentation.

Development Tips section should move above the Guideline Section

Screen Shot 2020-10-29 at 2 20 59 AM

@AmirNaghibi AmirNaghibi added the type: docs 📖 documentation is king label Oct 29, 2020
@AmirNaghibi AmirNaghibi changed the title CONTRIBUTING.md Development Tips section in wrong place docs: docs: CONTRIBUTING.md Development Tips section in wrong place Oct 29, 2020
@bobheadxi
Copy link
Member

Quoting from #715 (comment) :

I'm not sure this change makes much sense, since the guidelines section is for pull requests and not development - the development guide is separate because it is what you would consult once you're already familiar with the guidelines. There is already a link to skip to the development section so it's not like it's hard to find anything.

@bobheadxi
Copy link
Member

If anything, the fix should be to adjust the table of contents to just encapsulate the development section

@bobheadxi bobheadxi changed the title docs: CONTRIBUTING.md Development Tips section in wrong place docs: CONTRIBUTING.md Development Tips table of contents has strange scope Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs 📖 documentation is king
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants