-
Notifications
You must be signed in to change notification settings - Fork 131
docs: restructure docs IA and landing pages #668
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -174,49 +174,30 @@ const api = [ | |||||||||||||||||||||||||||||||||||||||||||||
| // }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ]; | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| const flags = [ | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "autogenerated", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "flags", | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ..._flags_items, | ||||||||||||||||||||||||||||||||||||||||||||||
| ]; | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| const docs = [ | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "doc", | ||||||||||||||||||||||||||||||||||||||||||||||
| id: "intro", | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "category", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "Getting Started", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "Editor", | ||||||||||||||||||||||||||||||||||||||||||||||
| collapsed: true, | ||||||||||||||||||||||||||||||||||||||||||||||
| items: [ | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "autogenerated", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "getting-started", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "editor", | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "category", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "Concepts", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "Forms", | ||||||||||||||||||||||||||||||||||||||||||||||
| collapsed: true, | ||||||||||||||||||||||||||||||||||||||||||||||
| items: [ | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "autogenerated", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "concepts", | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "category", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "Assistant", | ||||||||||||||||||||||||||||||||||||||||||||||
| collapsed: true, | ||||||||||||||||||||||||||||||||||||||||||||||
| items: [ | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "autogenerated", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "assistant", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "forms", | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -239,6 +220,39 @@ const docs = [ | |||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "category", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "With Figma", | ||||||||||||||||||||||||||||||||||||||||||||||
| collapsed: true, | ||||||||||||||||||||||||||||||||||||||||||||||
| items: [ | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "autogenerated", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "with-figma", | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "category", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "Design", | ||||||||||||||||||||||||||||||||||||||||||||||
| collapsed: true, | ||||||||||||||||||||||||||||||||||||||||||||||
| items: [ | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "autogenerated", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "design", | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "category", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "CLI", | ||||||||||||||||||||||||||||||||||||||||||||||
| collapsed: true, | ||||||||||||||||||||||||||||||||||||||||||||||
| items: [ | ||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "autogenerated", | ||||||||||||||||||||||||||||||||||||||||||||||
| dirName: "cli", | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
| ], | ||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+245
to
+255
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid promoting deprecated CLI docs as a normal top-level category.
Possible low-friction fix- label: "CLI",
+ label: "CLI (deprecated)",Based on learnings: Keep 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||
| type: "category", | ||||||||||||||||||||||||||||||||||||||||||||||
| label: "Models", | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -285,7 +299,6 @@ const wg = [ | |||||||||||||||||||||||||||||||||||||||||||||
| /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ | ||||||||||||||||||||||||||||||||||||||||||||||
| const sidebars = { | ||||||||||||||||||||||||||||||||||||||||||||||
| tutorialSidebar: docs, | ||||||||||||||||||||||||||||||||||||||||||||||
| flagsSidebar: flags, | ||||||||||||||||||||||||||||||||||||||||||||||
| togetherSidebar: together, | ||||||||||||||||||||||||||||||||||||||||||||||
| apiSidebar: api, | ||||||||||||||||||||||||||||||||||||||||||||||
| wgSidebar: wg, | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,27 +12,39 @@ This directory is the **source of truth** for documentation content. | |
|
|
||
| ## Actively maintained | ||
|
|
||
| We **only actively maintain** the following docs areas: | ||
| The most actively maintained docs areas are: | ||
|
|
||
| - `docs/wg/**` — working group docs (design notes, architecture, proposals, WIP) | ||
| - `docs/reference/**` — reference docs (glossary, specs, stable technical references) | ||
| - `docs/editor/**` — editor user and feature docs | ||
| - `docs/forms/**` — forms docs | ||
| - `docs/platform/**` — platform/product docs | ||
| - `docs/with-figma/**` — Figma interoperability, guides, and Assistant product docs | ||
| - `docs/design/**` — design-oriented product/reference docs | ||
| - `docs/math/**` — supporting technical references | ||
|
|
||
| ## SEO frontmatter | ||
|
|
||
| For docs SEO/frontmatter cleanup, start with the actively maintained areas: | ||
| `docs/wg/**` and `docs/reference/**`. Avoid broad repo-wide churn across | ||
| older docs sections unless the task explicitly asks for that migration. | ||
| For docs SEO/frontmatter cleanup, start with the actively maintained areas | ||
| above. Avoid broad repo-wide churn across deprecated, synced, or archived | ||
| sections unless the task explicitly asks for that migration. | ||
|
|
||
| When adding or meaningfully editing an actively maintained doc page, prefer | ||
| frontmatter with `title`, `description`, and `keywords`. For most `wg/` and | ||
| `reference/` Markdown pages that do not use MDX/JSX features, also include | ||
| `format: md` as described below. | ||
|
|
||
| ## Everything else | ||
| ## Special Cases | ||
|
|
||
| Some docs trees are intentionally kept, but have different ownership rules: | ||
|
|
||
| Other folders under `/docs` are **not actively managed**. | ||
| - `docs/cli/**` is deprecated. Keep it unless the task explicitly removes or rewrites deprecated CLI docs. | ||
| - `docs/@designto-code/**` is synced from an external source. Do not restructure or rewrite it unless the task explicitly targets that sync source. | ||
| - `docs/_history/**` contains archived, code-facing record material. It is not part of the user-facing docs surface; if you archive new docs, move them under `_history/` and mark each page `unlisted: true`. | ||
|
|
||
| ## Everything else | ||
|
|
||
| - Unless you have a specific task, **avoid editing** content outside `docs/wg/**` and `docs/reference/**`. | ||
| - Unless you have a specific task, prefer edits in the actively maintained areas above. | ||
| - Do not edit generated artifacts under `/apps/docs/docs/**`. | ||
|
|
||
| ## Universal routing (linking to editor pages) | ||
|
|
@@ -100,16 +112,19 @@ This prevents all MDX-related parsing issues for the entire file. | |
|
|
||
| ## Structure | ||
|
|
||
| | directory | name | description | active | | ||
| | -------------------------------- | ------------- | ---------------------------------------------------------------------- | ------ | | ||
| | [/docs/wg](./wg) | working group | working group documents, architecture documents, todo list, etc | yes | | ||
| | [/docs/wg/format](./wg/format) | format | Grida IR spec and CSS/HTML/SVG import mapping trackers | yes | | ||
| | [/docs/reference](./reference) | reference | glossary and references (technical documents) | yes | | ||
| | [/docs/math](./math) | math | Math reference, used for internal docs referencing | yes | | ||
| | [/docs/platform](./platform) | platform | Grida Platform (API/Spec) documents | yes | | ||
| | [/docs/editor](./editor) | editor | Grida Editor - User Documentation | yes | | ||
| | [/docs/forms](./forms) | forms | Grida Forms - User Documentation | yes | | ||
| | [/docs/canvas](./canvas) | canvas | Grida Canvas SDK - User Documentation | no | | ||
| | [/docs/cli](./cli) | cli | Grida CLI - User Documentation | yes | | ||
| | [/docs/together](./together) | together | Contributing, Support, Community, etc | yes | | ||
| | [/docs/with-figma](./with-figma) | with-figma | Grida with Figma - Grida <-> Figma compatibility and user guides | yes | | ||
| | directory | name | description | active | | ||
| | ---------------------------------------- | -------------- | ---------------------------------------------------------------------- | ------ | | ||
| | [/docs/wg](./wg) | working group | working group documents, architecture documents, todo list, etc | yes | | ||
| | [/docs/wg/format](./wg/format) | format | Grida IR spec and CSS/HTML/SVG import mapping trackers | yes | | ||
| | [/docs/reference](./reference) | reference | glossary and references (technical documents) | yes | | ||
| | [/docs/math](./math) | math | Math reference, used for internal docs referencing | yes | | ||
| | [/docs/platform](./platform) | platform | Grida Platform (API/Spec) documents | yes | | ||
| | [/docs/editor](./editor) | editor | Grida Editor - User Documentation | yes | | ||
| | [/docs/forms](./forms) | forms | Grida Forms - User Documentation | yes | | ||
| | [/docs/with-figma](./with-figma) | with-figma | Grida with Figma - Grida <-> Figma compatibility and user guides | yes | | ||
| | [/docs/design](./design) | design | Design-oriented docs and visual behavior notes | yes | | ||
| | [/docs/canvas](./canvas) | canvas | Grida Canvas SDK - User Documentation | no | | ||
| | [/docs/cli](./cli) | cli | Deprecated CLI docs kept for compatibility | no | | ||
| | [/docs/@designto-code](./@designto-code) | design-to-code | Externally synced reference docs | no | | ||
| | [/docs/\_history](./_history) | history | Archived, code-facing record docs not meant for user navigation | no | | ||
| | [/docs/together](./together) | together | Contributing, Support, Community, etc | no | | ||
|
Comment on lines
+115
to
+130
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix the two Static analysis is right here: these should include periods. Proposed typo fix-| [/docs/wg](./wg) | working group | working group documents, architecture documents, todo list, etc | yes |
+| [/docs/wg](./wg) | working group | working group documents, architecture documents, todo list, etc. | yes |
...
-| [/docs/together](./together) | together | Contributing, Support, Community, etc | no |
+| [/docs/together](./together) | together | Contributing, Support, Community, etc. | no |🧰 Tools🪛 LanguageTool[style] ~117-~117: In American English, abbreviations like “etc.” require a period. (ETC_PERIOD) [style] ~130-~130: In American English, abbreviations like “etc.” require a period. (ETC_PERIOD) 🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| id: configuration | ||
| title: "Framework & Configuration" | ||
| unlisted: true | ||
| --- | ||
|
|
||
| # Configuration | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| id: integrations | ||
| title: "Integrations" | ||
| unlisted: true | ||
| --- | ||
|
|
||
| # Integrations | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| id: examples | ||
| title: "Examples" | ||
| unlisted: true | ||
| --- | ||
|
|
||
| # Examples | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🌐 Web query:
For Next.js 16.2.4 projects, is it supported to keep@next/third-partieson 16.1.3, or should@next/* packages match the Next.js patch version?💡 Result:
No, it is not supported to keep
@next/third-partieson 16.1.3 when using Next.js 16.2.4. All@next/* packages should match the Next.js version (same major.minor.patch where possible).@next/third-partieshas a 16.2.2 release available that aligns with Next.js 16.2.4. Official docs recommend installing@next/third-parties@latest alongside next@latest, indicating version matching. The package is part of the Next.js monorepo, and mismatches can cause warnings or issues, as seen in similar cases with@next/swc. Peer dependencies are broad (^13+), but best practice is to use matching versions for compatibility, especially since patch releases include fixes.Citations:
Update
@next/third-partiesto match Next.js version.@next/third-partiesis pinned to16.1.3, butnextis now16.2.4. These packages should align—update@next/third-partiesto16.2.2or later to avoid compatibility issues.🤖 Prompt for AI Agents