GibsonAI Docs

This repository contains the documentation and public assets for GibsonAI.

Table of Contents

• Repository Structure
• Documentation
• Contributing

Repository Structure

This repository contains two main directories:

• content/ — Documentation sources in Markdown format
  • docs/ — Core documentation files organized by topic
  • shared-content/ — Reusable content components
• public/ — Public assets including images, fonts, and static files
  • images/ — Documentation images and assets
  • fonts/ — Typography assets
  • favicon/ — Website favicon files

Documentation

The documentation is organized into several key sections:

Getting Started

• Introduction to GibsonAI
• Signing up and account setup
• Connecting to GibsonAI

Guides

• Step-by-step tutorials
• Best practices
• Use case examples

Reference

• API documentation
• CLI commands and examples
• Technical specifications

Use Cases

• AI agents
• Business teams
• Database teams

Contributing

When contributing to the documentation:

1. Fork this repository
2. Create a new branch for your changes
3. Edit the relevant Markdown files in the content/ directory
4. Generate the LLM text file (see below)
5. Submit a pull request with a clear description of your changes

All documentation files are written in Markdown format and should follow standard Markdown conventions for consistency.

Generating LLM Text File

After making changes to any documentation files in the content/docs/ directory, you should regenerate the llms.txt file which combines all documentation content for LLM consumption:

python generate-llms-txt.py

This script will:

• Recursively read all Markdown files from the content/docs/ directory
• Combine their content into a single file
• Generate public/llms.txt with the consolidated documentation

Note: Always run this script after making documentation changes to ensure the LLM text file stays up-to-date with your modifications.