Skip to content

Conversation

@ultmaster
Copy link
Contributor

No description provided.

Copilot AI review requested due to automatic review settings August 22, 2025 06:16
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link

Copilot AI Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
@ultmaster ultmaster enabled auto-merge (squash) August 22, 2025 06:54
@ultmaster ultmaster merged commit 292c46c into main Aug 22, 2025
7 checks passed
@ultmaster ultmaster deleted the refactor-doc-structure branch August 27, 2025 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants