nvaldez 87b9b27f45 Add basic documentation stubs for project
- Add src/README.md with project overview, installation, and usage
- Update src/librarian/README.md with actual usage examples
- Add src/mdoctor/README.md with tool description and usage

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
2026-09-20 14:31:52 +02:00
2026-09-20 10:15:34 +02:00

Fiona-Assistant

Tools for managing the LLM wiki.

Development

Setup

  1. Create and activate the virtual environment:
    source bootstrap --env fiona_env -c
    

    Make sure fiona_env is activated as pyenv before proceeding

Testing

Run tests with pytest:

pytest

Usage

Run the fiona-assistant CLI with subcommands:

# Test command (via module)
python -m fiona test

# Or via entry point
fiona-assistant test

# List files with librarian
fiona-assistant librarian <directory>

# List files with mdoctor
fiona-assistant mdoctor <directory>

Note: Use fiona-assistant <command> or python -m fiona <command>

To see all available commands:

fiona-assistant --help
S
Description
Template for starting an LLM-Wiki
Readme 7.4 MiB
Languages
Python 90.5%
JavaScript 5.6%
Shell 1.6%
HTML 1.5%
PowerShell 0.8%