3ae48af67c
This PR starts putting in place the high-level changes we want to make to the docs site. - It makes separate sections for Reference and Examples and Community. - Gets rid of the secondary sidebar and integrates it into the main sidebar. - Groups the reference articles by type. - Pulls in the examples alongside code and a live playground so people don't have to visit examples.tldraw.com separately. <img width="1458" alt="Screenshot 2024-01-30 at 09 43 46" src="https://github.com/tldraw/tldraw/assets/469604/4f5aa339-3a69-4d9b-9b9f-dfdddea623e8"> Again, this is the top-level changes and there's more to be done for the next PR(s): - create quick start page - clean up installation page - add accordion to Examples page prbly - put fun stuff in header (from footer) - landing page - something for landing page of API - search cmd-k and border - cleanup _sidebarReferenceContentLinks - external links _blank - address potential skew issue with code examples - have a link to other examples (next.js, etc.) ### Change Type - [x] `documentation` — Changes to the documentation only[^2] ### Test Plan 1. Make sure examples work! ### Release Notes - Rework our docs site to pull together the examples app and reference section more cohesively. --------- Co-authored-by: Taha <98838967+Taha-Hassan-Git@users.noreply.github.com> Co-authored-by: Steve Ruiz <steveruizok@gmail.com> Co-authored-by: Mitja Bezenšek <mitja.bezensek@gmail.com> Co-authored-by: alex <alex@dytry.ch> Co-authored-by: Lu Wilson <l2wilson94@gmail.com> Co-authored-by: Dan Groshev <git@dgroshev.com>
206 lines
3.2 KiB
JSON
206 lines
3.2 KiB
JSON
[
|
|
{
|
|
"id": "getting-started",
|
|
"title": "Get Started",
|
|
"description": "Introduction articles for tldraw.",
|
|
"categories": [],
|
|
"sidebar_behavior": "show-links"
|
|
},
|
|
{
|
|
"id": "docs",
|
|
"title": "Learn tldraw",
|
|
"description": "Developer documentation for tldraw.",
|
|
"categories": [],
|
|
"sidebar_behavior": "show-links"
|
|
},
|
|
{
|
|
"id": "community",
|
|
"title": "Community",
|
|
"description": "Guides for contributing to tldraw's open source project.",
|
|
"categories": [],
|
|
"sidebar_behavior": "hidden"
|
|
},
|
|
{
|
|
"id": "reference",
|
|
"title": "API Reference",
|
|
"description": "Reference for the tldraw package's APIs (generated).",
|
|
"categories": [
|
|
{
|
|
"id": "editor",
|
|
"title": "@tldraw/editor",
|
|
"description": "",
|
|
"groups": [
|
|
{
|
|
"id": "Namespace",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Class",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Function",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Variable",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Enum",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Interface",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "TypeAlias",
|
|
"path": null
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "store",
|
|
"title": "@tldraw/store",
|
|
"description": "",
|
|
"groups": [
|
|
{
|
|
"id": "Namespace",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Class",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Function",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Variable",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Enum",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Interface",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "TypeAlias",
|
|
"path": null
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "tldraw",
|
|
"title": "@tldraw/tldraw",
|
|
"description": "",
|
|
"groups": [
|
|
{
|
|
"id": "Namespace",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Class",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Function",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Variable",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Enum",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Interface",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "TypeAlias",
|
|
"path": null
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "tlschema",
|
|
"title": "@tldraw/tlschema",
|
|
"description": "",
|
|
"groups": [
|
|
{
|
|
"id": "Namespace",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Class",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Function",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Variable",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Enum",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Interface",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "TypeAlias",
|
|
"path": null
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "validate",
|
|
"title": "@tldraw/validate",
|
|
"description": "",
|
|
"groups": [
|
|
{
|
|
"id": "Namespace",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Class",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Function",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Variable",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Enum",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "Interface",
|
|
"path": null
|
|
},
|
|
{
|
|
"id": "TypeAlias",
|
|
"path": null
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"sidebar_behavior": "reference"
|
|
}
|
|
]
|