docs(cli)📝: Update CLI documentation for the llamabot docs write command
#91
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
…mmand - Revise main title and sections for `llamabot docs write`. - Clarify `--force` usage and introduce `from_scratch` parameter. - Add examples and explain frontmatter key-value pairs.
- Replace the `--force` flag with the `--from-scratch` flag. - Clarify usage by instructing to open terminal and navigate to project root. - Update command description to include 'intents in Markdown source files'. - Change section titles from 'Options' to 'Flags' and update frontmatter. - Provide a usage example for the `--from-scratch` flag. - Refine explanation of frontmatter for better context and instructions.
…ng from scratch - Move content clearing to start of write function if from_scratch is true.
- Reformatted the `--from-scratch` flag section for better clarity. - Updated frontmatter section to specify YAML format. - Simplified the example section with a complete Markdown file. - Changed file and intent sections in Python script for clearer content blocks.
…nges and add new test cases - Updated documentation and test suite for new source code changes. - Added comprehensive test cases for documentation validation.
- Add explanation of how linked files are referenced. - Detail the mechanism of referencing files in `linked_files` key. - Provide an example of relative path usage for linked files.
- Provide a tutorial on how to use the prime number function. - Explain any optimizations made in the source code.
- Change task_message return type to HumanMessage in StructuredBot. - Substitute DocumentationOutOfDate with ModelValidatorWrapper. - Add ood_checker_bot and docwriter_bot functions for bot instance creation. - Update write function to use new bot functions and handle doc updates. - Fix class name typos in test cases to DocsDoNotCoverIntendedMaterial.
- Implement is_prime function to check primality. - Create next_prime function to find the next prime number after a given number.
…and improve function documentation - Import pathlib and use Path for reading external prime number source code. - Update docstrings in is_prime and next_prime with parameter and return details. - Modify is_prime base case to check for n < 2 and add a case for n == 3.
- Change pytest marker from llm_evals to llm.
…guration - Change pytest marker from 'llm' to 'llm_eval' in test_docs.py. - Update pytest addopts in pyproject.toml to use the new 'llm_eval' marker. - Update sha256 in pixi.lock for llamabot package.
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.
llamabot docs write.--forceusage and introducefrom_scratchparameter.