Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the documentation structure to improve organization and navigation. The changes focus on reorganizing content into clearer sections and updating navigation paths accordingly.
Key changes include:
- Reorganized navigation structure with dedicated "Tutorial" and "Language Spec" sections
- Added new MkDocs plugins for enhanced documentation features
- Updated file paths and references to match the new structure
Reviewed Changes
Copilot reviewed 7 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| typedoc.json | Enabled clean output directory for TypeScript documentation |
| pyproject.toml | Added MkDocs plugins for git revision dates and author information |
| mkdocs.yml | Restructured navigation hierarchy and added new plugin configurations |
| docs/typescript/index.md | Added API stability warnings and updated reference link |
| docs/tutorial/quickstart.md | Updated cross-references to match new file structure |
| docs/python/index.md | Updated reference links to new reference directory structure |
| docs/index.md | Updated sitemap link to point to reorganized tutorial section |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| - [Components Documentation](../language/components.md): detailed component specifications with examples and parameters. | ||
| - [TypeScript API Reference](./reference/README.md): auto-generated API reference for TypeScript components and utilities. | ||
| - [TypeScript API Reference](./reference/index.md): auto-generated API reference for TypeScript components and utilities. |
There was a problem hiding this comment.
The reference link points to index.md but TypeDoc typically generates a README.md file as the main entry point. This may result in a broken link if the generated documentation uses README.md instead of index.md.
Suggested change
| - [TypeScript API Reference](./reference/index.md): auto-generated API reference for TypeScript components and utilities. | |
| - [TypeScript API Reference](./reference/README.md): auto-generated API reference for TypeScript components and utilities. |
This file contains hidden or 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
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.
No description provided.