Skip to content

Link to docs contribution and text formatting guidelines #902

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

Conversation

valeriahhdez
Copy link
Contributor

@valeriahhdez valeriahhdez commented Aug 31, 2024

Expand on the documentation contribution workflows and conventions.

Document instructions to style text and to use Markdown tags in JSON Schema documentation.

What kind of change does this PR introduce?
It adds information on how to contribute to the JSON Schema documentation to the Improving documentation section

Issue Number:

Screenshots/videos:

If relevant, did you update the documentation?

Summary

This update explicitly states the two types of contributions to documentation: working on existing issues and proposing modifications.

Does this PR introduce a breaking change?

No

Add more info on how to contribute to JSON Schema documentation
@valeriahhdez valeriahhdez self-assigned this Sep 3, 2024
Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

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

I think it would be a good idea to create a style guide to provide some consistency about tone, structure and other resources. For example:
https://docs.medusajs.com/contribution/docs

You can place inside the docs folder like we did with the blog guidelines.

And please, remember we have this page (unused for now) with a guide on how to write markdown. https://json-schema.org/md-style-guide

I think we should create a style guide and see how we integrate this page.

@valeriahhdez valeriahhdez changed the title Update Improving documentation section Document docs contribution and text formatting guidelines Sep 21, 2024
Improve docs contribution guidance: Reference CONTRIBUTING-docs.md and style-guide.md
@valeriahhdez
Copy link
Contributor Author

I added a new commit that directs people to the new contribution and style guides for documentation.

PR #982 contains the changes I'm proposing to set clear documentation contribution processes and create consistent documentation for JSON Schema.

@valeriahhdez valeriahhdez changed the title Document docs contribution and text formatting guidelines Link to docs contribution and text formatting guidelines Sep 29, 2024
@benjagm benjagm deleted the branch json-schema-org:web-feat-diataxis October 2, 2024 08:11
@benjagm benjagm closed this Oct 2, 2024
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.

2 participants