init documentation #33
Merged
Conversation
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
- Set up MkDocs with Material theme for documentation - Create documentation structure: quickstart, how-to, deep-dive, reference - Configure auto-generated API reference from Python docstrings - Add GitHub Actions workflow for automatic deployment to GitHub Pages - Enable version management with mike for versioned docs - Add git plugins for author and update time tracking 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Add comprehensive step-by-step guide for building first Agent Lightning app - Include detailed explanations for each code section - Add output interpretation sections for both client and server - Explain behind-the-scenes operations and telemetry - Reference complete example code in examples/apo - Make writing more natural and consolidate steps 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Major improvements:
- Add version-aware repository links using template variables
- Move assets to docs/assets for proper MkDocs integration
- Add Mermaid diagram support for flowcharts and visualizations
- Reorganize navigation structure (disable top tabs, sidebar-only)
- Add comprehensive documentation build testing in CI
- Configure mkdocs-macros-plugin for dynamic content
- Update GitHub Actions workflows for proper docs deployment
Documentation structure:
- Quickstart: Installation and Getting Started guides
- How-To Guides: Training examples including SQL agent
- Deep Dive: Architecture and concepts
- API Reference: Auto-generated from docstrings
All repository links now use {{ config.repo_url }}/tree/{{ config.extra.source_commit }}
to ensure version consistency between docs and code.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Features added: - Static light logo in sidebar navigation - Dynamic favicon that switches based on user's theme preference - Automatic detection of system theme (prefers-color-scheme) - Real-time favicon switching when user toggles theme in docs - Proper path resolution for favicon assets across all pages Logo implementation: - logo-light.png: Used for sidebar logo (always visible) - logo-dark.png/logo-light.png: Used for favicon based on theme - JavaScript handles automatic theme detection and manual overrides - Works seamlessly across all documentation pages Technical details: - favicon-theme.js handles dynamic switching - Uses MutationObserver to detect theme changes - Constructs proper absolute paths for assets - Removes existing favicons to prevent conflicts 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Fix grammar in getting-started guide for better clarity. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR initializes comprehensive documentation infrastructure for the Agent Lightning project using MkDocs with Material theme. The documentation includes installation guides, getting started tutorials, API references, and a practical SQL agent training example.
Key changes:
- Set up MkDocs Material theme with documentation build pipeline
- Added comprehensive installation and getting started guides
- Created API reference documentation structure
- Added detailed SQL agent training tutorial with performance metrics
Reviewed Changes
Copilot reviewed 17 out of 24 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Added MkDocs and related dependencies to dev requirements |
| mkdocs.yml | Complete MkDocs configuration with Material theme, plugins, and navigation structure |
| docs/*.md | Documentation content including installation guide, getting started tutorial, API references, and SQL agent example |
| docs/js/favicon-theme.js | Dynamic favicon switching based on light/dark theme |
| .github/workflows/*.yml | CI/CD workflows for building and deploying documentation |
| examples/spider/sql_agent.py | Added debug print statement for graph visualization |
| examples/apo/apo_client.py | Updated parameter name from 'endpoint' to 'backend' |
| agentlightning/verl/*.py | Minor documentation formatting fixes |
| README.md | Updated asset paths to point to docs directory |
examples/spider/sql_agent.py
Outdated
|
|
||
| return builder.compile() | ||
| g = builder.compile() | ||
| print(g.get_graph().draw_mermaid()) |
There was a problem hiding this comment.
This debug print statement should be removed or made conditional (e.g., behind a debug flag) before merging to avoid cluttering production output.
Suggested change
| print(g.get_graph().draw_mermaid()) | |
| if os.environ.get("DEBUG_SQL_AGENT") == "1": | |
| print(g.get_graph().draw_mermaid()) |
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.