Create Documentation Website with mkdocs and GitHub Pages #2
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
Contributor
Author
|
@openhands-agent I noticed that some actions like calculator are mentioned even though they are not available. Please read the codebase thoroughly and update the docs |
- Initialize mkdocs with Material theme - Create documentation structure and content - Add GitHub Actions workflow for automatic deployment - Update README with documentation links - Remove mentions of calculator action that is not available - Add comprehensive documentation for agents and actions - Include local development guide for documentation
leandermaben
force-pushed
the
openhands/create-documentation-website
branch
from
5ac6d0d to
6277ab7
Compare
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.
This PR addresses issue #1 by creating a comprehensive documentation website using mkdocs and GitHub Pages.
Changes Made:
Set up mkdocs with Material theme for documentation
Created documentation pages for:
Added GitHub Actions workflow for automatic deployment to GitHub Pages
Updated README.md with links to the documentation site
Added .gitignore entry for the site directory
How to Test:
mkdocs serveto preview the documentation locallyOnce merged, the documentation will be automatically deployed to GitHub Pages and accessible at https://sentientia.github.io/Aura/
Fixes #1
@leandermaben can click here to continue refining the PR