Skip to content

Conversation

@geyang
Copy link
Contributor

@geyang geyang commented Nov 4, 2025

Summary

This PR improves the documentation landing page and build system:

  • Simplifies installation instructions in index.md
  • Adds complete training example with PyTorch code
  • Updates Core Concepts section with descriptive titles
  • Adds clean target to Makefile for removing docs/_build
  • Updates preview target to clean before building
  • Removes broken getting-started.md references
  • Cleans up api-quick-reference.md links

Changes

Documentation Content

  • Rewrote index.md with clearer structure and better examples
  • Added inline training code example with nn.Sequential MLP
  • Updated toctree titles for better navigation
  • Removed duplicate/orphaned files (getting-started.md, overview.md)

Build System

  • Added make clean target to remove build artifacts
  • Modified make preview to always do a clean build
  • Updated help text with new commands

Testing

  • Documentation builds successfully
  • All referenced files exist
  • Navigation structure is correct

@tom.tao57 Please review the documentation improvements.

🤖 Generated with Claude Code

- Simplify installation instructions in index.md
- Add complete example with training code
- Update Core Concepts section with descriptive titles
- Add clean target to Makefile for docs/_build removal
- Update preview target to clean before building
- Remove broken getting-started.md references
- Clean up api-quick-reference.md links

These changes improve the documentation landing page and make the
build system more robust with proper cleanup.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
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