New information architecture #1194
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DhairyaMajmudar
requested changes
Dec 25, 2024
There was a problem hiding this comment.
@valeriahhdez pls. resolve the failing lint workflow. For doing so you've to run the command yarn run lint:fix
pages/learn/guides/index.page.tsx
Outdated
| import Head from 'next/head'; | ||
| import { Headline1 } from '~/components/Headlines'; | ||
| import { SectionContext } from '~/context'; | ||
| import Card from '~/components/Card'; |
There was a problem hiding this comment.
Pls. remove this unused import
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1194 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 10 10
Lines 373 373
Branches 94 94
=========================================
Hits 373 373 ☔ View full report in Codecov by Sentry. |
1 task
valeriahhdez
added
Status: In Progress
|
Hi @benjagm, Can you please review this PR? |
benjagm
requested changes
Jan 26, 2025
There was a problem hiding this comment.
This is looking awesome!!
This is almost done, I just found some small comments I am providing below:
- Rebase to the last changes to get the implementation of the prev / next buttons.
- The PR is missing all the redirects implemented in "public/_redirects" from pages we are removing from the sidebar like:
- /understanding-json-schema
- Introduction - Looks great
- Getting Started - Looks great
- "JSON Schema common terms" I would say the title seems now confusing. I would suggest we leave JSON Schema Glossary for now.
- Guides
- I suggest we move here "For Implementers" currently in Reference.
- Reference
- I think we could add some additional links in the Overview page at the bottom with some links and a message in case the users is looking for the very basic:
- What is JSON Schema
- What is a Schema
- The basics
- Creating your first Schema.
And another link to Specification in case the user is looking for the Spec itself?
- I suggest we move to the bottom "Learn JSON Schema" as a complementary resource to the reference.
- The overview page cards is missing 2 subsections:
- Conditional schema validation
- Media: string-encoding non-JSON data
- I suggest we move here "For Implementers" into guides.
- I think we could add some additional links in the Overview page at the bottom with some links and a message in case the users is looking for the very basic:
Great work. This is just small details.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
This PR changes the information architecture of the documentation with the following changes:
**Issue Number:
Screenshots/videos:
If relevant, did you update the documentation?
Yes, I made changes to several documents within the reference content bucket.
Summary
This PR addresses the needs of the GSoD project, more specifically, milestone 5 of the documentation strategy.
The problem: we need to reorganize the information in a coherent way to onboard people new to JSON Schema and make it easier for readers to find what they’re looking for.
The goals:
To streamline developer workflows by revamping our documentation architecture with the diataxis approach.
To conduct a style overhaul for a more intuitive and cohesive developer experience.
You can see a slide deck summarizing this work here.
Does this PR introduce a breaking change? No