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]: Create a standalone introductory guide to JSON Schema #1129

Open
1 task done
valeriahhdez opened this issue Nov 21, 2024 · 2 comments · May be fixed by #1148
Open
1 task done

[📝 Docs]: Create a standalone introductory guide to JSON Schema #1129

valeriahhdez opened this issue Nov 21, 2024 · 2 comments · May be fixed by #1148
Assignees
Labels
📝 Documentation Indicates improvements or additions to documentation.

Comments

@valeriahhdez
Copy link
Contributor

valeriahhdez commented Nov 21, 2024

What Docs changes are you proposing?

Create a self-contained document product that introduces beginners to JSON Schema to replace two documents that are currently formatted as book chapters:

A book chapter format presents information in a sequential manner, where each chapter builds upon the previous one. This means chapters lack clear learning goals and the reader needs to complete more than one chapter to complete a task or learning lesson.

An introductory guide to JSON Schema that is self-contained should comply with the following requirements to replace the book chapters mentioned above:

  • clear learning goals for the reader
  • a start and end points
  • link to other learning resources
  • be clear, concise, and accurate

Code of Conduct

  • I agree to follow this project's Code of Conduct
@valeriahhdez valeriahhdez added 📝 Documentation Indicates improvements or additions to documentation. Status: Triage This is the initial status for an issue that requires triage. labels Nov 21, 2024
@valeriahhdez valeriahhdez added the Status: Available No one has claimed responsibility for resolving this issue. label Nov 21, 2024
@techmannih
Copy link
Contributor

@valeriahhdez @DhairyaMajmudar May I work on this issue

@valeriahhdez
Copy link
Contributor Author

valeriahhdez commented Nov 28, 2024

Hi @techmannih, yes, you can go ahead

@techmannih techmannih linked a pull request Dec 2, 2024 that will close this issue
@valeriahhdez valeriahhdez removed Status: Triage This is the initial status for an issue that requires triage. Status: Available No one has claimed responsibility for resolving this issue. labels Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation.
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

2 participants