Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(llamabot/cli/docs)📝: Add a new CLI tool for managing Markdown documentation #90

Merged
merged 14 commits into from
Aug 30, 2024

Commits on Aug 28, 2024

  1. docs(devcontainer)📝: Update documentation for development container

    - Overview of dev container build and installed software.
    - Detail devcontainer.json influence on dev environment.
    - Explain common build failures and resolutions.
    ericmjl committed Aug 28, 2024
    Configuration menu
    Copy the full SHA
    bef4095 View commit details
    Browse the repository at this point in the history
  2. docs(devcontainer)📝: Update documentation for development container s…

    …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.
    ericmjl committed Aug 28, 2024
    Configuration menu
    Copy the full SHA
    7d5f315 View commit details
    Browse the repository at this point in the history
  3. feat(llamabot/cli/docs)📝: Add a new CLI tool for managing Markdown do…

    …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.
    ericmjl committed Aug 28, 2024
    Configuration menu
    Copy the full SHA
    38cc543 View commit details
    Browse the repository at this point in the history
  4. feat(.devcontainer)🐳: Update Dockerfile to enhance development enviro…

    …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.
    ericmjl committed Aug 28, 2024
    Configuration menu
    Copy the full SHA
    9d21bcf View commit details
    Browse the repository at this point in the history

Commits on Aug 29, 2024

  1. docs(chatbot tutorial)📝: Update the ChatBot tutorial documentation

    - 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.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    ee705ee View commit details
    Browse the repository at this point in the history
  2. feat(llamabot/cli)📝: Add documentation generation command to CLI

    - 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.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    bf9f8b6 View commit details
    Browse the repository at this point in the history
  3. feat(docbot)📝: Add a new Jupyter notebook for the docbot functionality

    - 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.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    38e081b View commit details
    Browse the repository at this point in the history
  4. feat(dependencies)📦: Add python-frontmatter package to project depend…

    …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.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    b30a1f9 View commit details
    Browse the repository at this point in the history
  5. fix(pixi.lock)🔒: Update the SHA256 hash for llamabot package.

    - Updated SHA256 hash in pixi.lock for llamabot package.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    c770527 View commit details
    Browse the repository at this point in the history
  6. chore(.pre-commit-config)🔧: Add local hook for pixi installation

    - 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.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    748e048 View commit details
    Browse the repository at this point in the history
  7. ci(code-style)👷: Add Pixi environment setup to GitHub Actions workflow

    - Add new step to setup Pixi environment.
    - Configure Pixi v0.25.0 with caching.
    - Enable cache writing for pushes to main branch.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    dc5a12d View commit details
    Browse the repository at this point in the history
  8. docs(tutorials)📝: Update the recording prompts tutorial for better cl…

    …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.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    d9edd06 View commit details
    Browse the repository at this point in the history
  9. docs(simplebot)📝: Update the SimpleBot tutorial documentation

    - 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 committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    80fa9e8 View commit details
    Browse the repository at this point in the history
  10. feat(documentation)📝: Add guided tutorial for llamabot docs write c…

    …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.
    ericmjl committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    0a07972 View commit details
    Browse the repository at this point in the history