llm-contracts Documentation
This directory contains the documentation for the llm-contracts project, published using GitHub Pages.
Local Development
To preview the documentation locally:
- Install Jekyll and dependencies:
gem install jekyll bundler bundle install - Run the Jekyll server:
bundle exec jekyll serve - Open your browser to
http://localhost:4000
Documentation Structure
index.md: Home pageinstallation.md: Installation guidegetting-started.md: Getting started guidefeatures.md: Core features documentationfrontend.md: Web frontend documentationexamples.md: Usage examplesapi-reference.md: API reference
Adding Content
To add new pages:
- Create a new Markdown file with the following front matter:
--- layout: default title: Your Page Title nav_order: [order number] description: "Page description" --- - Add your content in Markdown format
Publishing
The documentation is automatically published to GitHub Pages when changes are pushed to the main branch.