feat(llamabot/cli/docs)📝: Add a new CLI tool for managing Markdown documentation #90
Conversation
This file contains 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
Owner
ericmjl
commented
Aug 29, 2024
ericmjl
commented
- Create a new file llamabot/cli/docs.py to handle Markdown documentation.
- Implement classes for Markdown source files and documentation status checking.
- Integrate Typer for CLI command handling.
- Use pydantic for validation and frontmatter for Markdown metadata.
- Overview of dev container build and installed software. - Detail devcontainer.json influence on dev environment. - Explain common build failures and resolutions.
…etup - Highlight `devcontainer.json` influence. - Detail inclusion of `tests` and `llamabot` directories. - Describe 'ollama' software installation. - Explain `postCreateCommand` and `postStartCommand` purposes. - Clarify troubleshooting for common failure modes.
…cumentation - Create a new file llamabot/cli/docs.py to handle Markdown documentation. - Implement classes for Markdown source files and documentation status checking. - Integrate Typer for CLI command handling. - Use pydantic for validation and frontmatter for Markdown metadata.
…nment setup - Replace environment.yml with pixi.lock and pyproject.toml. - Add copying of docs, llamabot, and tests directories to container. - Update Ollama installation command with detailed comment.
- Revised the structure and content of the ChatBot tutorial. - Added detailed steps on using the ChatBot class in a Jupyter notebook. - Included instructions for serving a Panel app based on the ChatBot class. - Explained the message retrieval process for API calls with the ChatBot class.
- Added a new CLI command for Markdown documentation generation. - Implemented a save method in MarkdownSourceFile for file updates. - Refactored documentation_information function for better output. - Updated write command to handle outdated or empty documentation.
- Create a new Jupyter notebook to integrate various documentation tools. - Set up autoreload for dynamic updates during development. - Implement code cells for handling documentation checks and updates.
…encies - Include python-frontmatter 1.1.0 in the project's dependency list. - Update pixi.lock and pyproject.toml to reflect the new dependency. - Ensure compatibility with existing packages and Python >=3.10.
- Updated SHA256 hash in pixi.lock for llamabot package.
- Add a new local hook in the pre-commit configuration. - Configure the hook to always run and not pass filenames. - Set the hook to require serial execution.
- Add new step to setup Pixi environment. - Configure Pixi v0.25.0 with caching. - Enable cache writing for pushes to main branch.
…arity and integration - Revised the tutorial introduction to include a how-to guide format. - Added metadata section with intents and linked files for better navigation. - Updated import paths to reflect new module structure in llamabot. - Changed parameter name from 'doc_paths' to 'document_paths' for consistency.
- Add detailed sections on AIMessage object, explaining its structure and usage. - Update import paths for SimpleBot to reflect new module structure. - Include additional information on using the Panel app with SimpleBot. - Provide links to linked files in the documentation.
ericmjl
commented
Aug 29, 2024
…ommand - Create a new documentation file for the LlamaBot CLI. - Include usage instructions and options for `llamabot docs write`. - Provide information on the `--force` flag usage. - Explain requirements for target documentation file formatting and placement. - Detail necessary frontmatter key-value pairs for the command.
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.