New information architecture #1194

valeriahhdez · 2024-12-21T15:41:05Z

What kind of change does this PR introduce?
This PR changes the information architecture of the documentation with the following changes:

Aligns content buckets to the diataxis framework to documentation.
Creates a new content bucket for Guides (to be populated)
Restructures the navigation of the Reference content bucket by eliminating deep nesting.
Edits titles for consistency and clarity.
Reallocates documents to create a coherent organization.
Adds an Overview page providing context and expectations for each content bucket and the Reference sections that contain nested documents.

**Issue Number:

Closes [📝 Docs]: Improve documentation's information architecture #790
Related to Execute the documentation strategy #158
Others?

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

…-schema-org#1091) * merge obsolete hyper libraries * merge obsolete validators * update tooling data schema * add json-schema-benchmark to obsolete * add obsolete tag * add showObsolete transform to tooling page * merge remaining obsolete tools * fix failing instances of tooling data * add show obsolete button to siderbar * add redirect * maybe fix style purging * this should fix it

DhairyaMajmudar

@valeriahhdez pls. resolve the failing lint workflow. For doing so you've to run the command yarn run lint:fix

DhairyaMajmudar · 2024-12-25T12:55:15Z

pages/learn/guides/index.page.tsx

+import Head from 'next/head';
+import { Headline1 } from '~/components/Headlines';
+import { SectionContext } from '~/context';
+import Card from '~/components/Card';


Pls. remove this unused import

This reverts commit 6dd9ed4.

[Feat]-Add protoc-gen-jsonschema

Bumps [slate](https://github.com/ianstormtaylor/slate) from 0.110.2 to 0.112.0. - [Release notes](https://github.com/ianstormtaylor/slate/releases) - [Commits](https://github.com/ianstormtaylor/slate/compare/[email protected]@0.112.0) --- updated-dependencies: - dependency-name: slate dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…hema-org#1198) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 5.1.1 to 5.1.2. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@v5.1.1...v5.1.2) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* improve Specification table design * fix lint error * replace blue-600 to primary color

Removed a duplicated text

* Added Next Prev Button in docs/Overview * Changed local host to public hosted URL * Made Changes for Build * Made Changes to the Overview * Added Navigation in Docs/ Getting Started * Added NavButton in learn * Correct NavButtons Build Error

github-actions · 2025-01-06T17:22:37Z

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name	Status	Preview	Last Commit
website	✅ Ready (View Log)	Visit Preview	`a01a0bc`

codecov · 2025-01-06T17:23:15Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (27398a9) to head (a01a0bc).
Report is 35 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

…on-schema-org#1357)

* fix[tools]: fix markdown render in tools page * fix[tools]: use StyledMarkdown instead of directly using library

* Added proper links for jsonschema-core.md and jsonschema-validation.md in specification-links.md * the specification dropdown fix * changes * changes * changes --------- Co-authored-by: Shantanu Chauhan <[email protected]>

* fix[docs]: update arrow links across pages and sidebar * fix[docs]: align sidebar and add navigation buttons to pro-help page * fix[docs]: fix prettier issue

…hema-org#1378) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 5.1.2 to 5.3.1. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@v5.1.2...v5.3.1) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…a-org#1364) * feat: making community page image section dynamic * fix: removed contributor images and community.json file

…g#1380) Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 22.4.2 to 22.10.10. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) --- updated-dependencies: - dependency-name: "@types/node" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…1206) * docs: add note clarifying multipleOf implementation add a note explaining the difference between float-point implementation of programming languages and json schema * fix: reword note on numerical precision * fix: clarify wording in numerical precision note

…1295)

…org#1297) * fix[docs/learn]: correct vertical alignment issue in schema example * fix[docs/learn]: remove unused replace and restore font sizes post testing * fix[json-editor]: add horizontal scroll to json-editor

Bumps [next-themes](https://github.com/pacocoursey/next-themes) from 0.3.0 to 0.4.4. - [Release notes](https://github.com/pacocoursey/next-themes/releases) - [Commits](pacocoursey/next-themes@v0.3.0...v0.4.4) --- updated-dependencies: - dependency-name: next-themes dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Oracle case study * Oracle case study, minor fixes * JSON format inside tables, InfoBox and Warning components, Markdown imdage component * Title modification * Banner change, JSON in table format * Banner change, JSON in table format, InfoBox, Danger * Banner change, JSON in table format * Banner change * Applying blog style * Rollback to previous version * Removing duplicate picture.

…eriahhdez/website into pr/1194

valeriahhdez · 2025-02-15T12:34:58Z

I am closing this PR to open a new one that contains the Prev/Next navigation and the changes requested in this review.

valeriahhdez added 6 commits November 18, 2024 21:32

Change sidebar names

9fa2e26

Change sidebar names

46a4492

Change structure of reference content bucket

c373ea5

Merge branch 'json-schema-org:main' into new-information-architecture

e2a423e

Create Guides content bucket, add overview pages to every bucket

63b59cf

Modify type.md to provide context about to readers

6f8c248

valeriahhdez self-assigned this Dec 21, 2024

valeriahhdez requested a review from a team as a code owner December 21, 2024 15:41

valeriahhdez added this to the Docs Release 5 milestone Dec 22, 2024

Update on Dockerfile Implementation for Windows Users

6dd9ed4

DhairyaMajmudar requested changes Dec 25, 2024

View reviewed changes

DhairyaMajmudar reviewed Dec 25, 2024

View reviewed changes

Adi-204 and others added 14 commits December 26, 2024 15:42

Revert "Update on Dockerfile Implementation for Windows Users"

2e769f0

This reverts commit 6dd9ed4.

Update INSTALLATION.md

98fe449

Add protoc-gen-jsonschema

c4c6a9a

Merge pull request json-schema-org#1213 from Adi-204/improve

f46a771

[Feat]-Add protoc-gen-jsonschema

improve Specification page design (json-schema-org#1207)

f3cb1b8

* improve Specification table design * fix lint error * replace blue-600 to primary color

Update conventions.md (json-schema-org#1107)

7e80c14

Removed a duplicated text

blog post for an update on the spec

6d73f73

update publish date

e49bf99

fix typo

918f76b

updates from re-reading it after I've slept

b02e20a

Remove unsed import

a01a0bc

github-actions bot deployed to Preview January 6, 2025 17:22 View deployment

cbum-dev and others added 26 commits February 1, 2025 12:47

Update index.page.tsx (json-schema-org#1354)

0f44216

solve the dropdown issue (json-schema-org#1358)

91ad4a9

Change cypress-ajv-schema-validator from Javascript to JavaScript (js…

5abdd7b

…on-schema-org#1357)

Fix - fix markdown render in tools page (json-schema-org#1351)

32a4525

* fix[tools]: fix markdown render in tools page * fix[tools]: use StyledMarkdown instead of directly using library

add hover effects with cursor pointer (json-schema-org#1348)

b7028cc

Feature/bug#1355 (json-schema-org#1366)

1346905

* Added proper links for jsonschema-core.md and jsonschema-validation.md in specification-links.md * the specification dropdown fix * changes * changes * changes --------- Co-authored-by: Shantanu Chauhan <[email protected]>

Fix : pro help sidebar alignment and add buttons (json-schema-org#1310)

7b128df

* fix[docs]: update arrow links across pages and sidebar * fix[docs]: align sidebar and add navigation buttons to pro-help page * fix[docs]: fix prettier issue

Feat: Dynamic contributors' avatars in the Community page (json-schem…

82c086f

…a-org#1364) * feat: making community page image section dynamic * fix: removed contributor images and community.json file

fix: removed terminal errors from .eslintrs.js file (json-schema-org#…

6bec791

…1295)

solve the bowtie loading error (json-schema-org#1353)

d7dbd1f

fix: community page avatars loading optimised (json-schema-org#1389)

57a3894

Integrate feedback comments

9d54f06

Change sidebar names

634ec47

Change structure of reference content bucket

fe9c9b5

Change sidebar names

76039fb

Modify type.md to provide context about to readers

04df433

Remove unsed import

4acde6a

Integrate feedback comments

c9ee5b8

Fix navigation

15b431d

Merge branch 'new-information-architecture' of https://github.com/val…

6abb805

…eriahhdez/website into pr/1194

benjagm marked this pull request as draft February 9, 2025 19:07

benjagm mentioned this pull request Feb 9, 2025

New information Architecture #1403

Draft

valeriahhdez closed this Feb 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New information architecture #1194

New information architecture #1194

valeriahhdez commented Dec 21, 2024 •

edited

Loading

DhairyaMajmudar left a comment

DhairyaMajmudar Dec 25, 2024

github-actions bot commented Jan 6, 2025 •

edited

Loading

codecov bot commented Jan 6, 2025 •

edited

Loading

valeriahhdez commented Feb 15, 2025

New information architecture #1194

New information architecture #1194

Conversation

valeriahhdez commented Dec 21, 2024 • edited Loading

DhairyaMajmudar left a comment

Choose a reason for hiding this comment

DhairyaMajmudar Dec 25, 2024

Choose a reason for hiding this comment

github-actions bot commented Jan 6, 2025 • edited Loading

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

codecov bot commented Jan 6, 2025 • edited Loading

Codecov Report

valeriahhdez commented Feb 15, 2025

valeriahhdez commented Dec 21, 2024 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading

codecov bot commented Jan 6, 2025 •

edited

Loading