Contributing to Logic AI Documentation

Thank you for your interest in contributing to the Logic AI documentation! This guide will help you set up the GitBook locally and contribute effectively.

Getting Started

Prerequisites

• Node.js (v10.x or higher)
• npm (usually comes with Node.js)
• Git

Local Setup

1. Clone the repository:

   git clone https://github.com/logic-ai/documentation.git
   cd documentation
   

2. Install dependencies:

   npm install
   

3. Start the local server:

   npm run serve
   

4. Open your browser and navigate to http://localhost:4000 to see the documentation.

Contribution Guidelines

Documentation Structure

Our documentation follows this structure:

• README.md: The landing page
• SUMMARY.md: The navigation sidebar structure
• Content directories:
  • getting-started/: Introductory information
  • features/: Detailed feature documentation
  • tutorials/: Step-by-step guides
  • technical/: Technical references
  • tokenomics/: Token information
  • support/: Support resources
  • roadmap/: Development timeline

Creating Content

1. Page Creation: All pages should be created as Markdown (.md) files.
2. Navigation: Update the SUMMARY.md file to include your new page.
3. Images: Place images in the assets/ directory and reference them using relative paths.
4. Links: Use relative links to connect pages.

Style Guidelines

• Use clear, concise language
• Break content into logical sections with headings
• Use lists and tables for structured information
• Include examples and screenshots where helpful
• Follow the Google developer documentation style guide

Submitting Changes

1. Create a new branch for your changes:

   git checkout -b feature/your-feature-name
   

2. Make your changes and test them locally.

3. Commit your changes with a clear commit message:

   git commit -m "Add documentation for feature X"
   

4. Push your branch:

   git push origin feature/your-feature-name
   

5. Open a pull request against the main branch.

Building the Documentation

To generate a static site:

npm run build

This will create a _book directory with the static site.

To generate a PDF:

npm run pdf

Need Help?

If you have any questions about contributing, please:

• Open an issue in the repository
• Contact the documentation team at docs@logicai.com

Thank you for helping improve the Logic AI documentation!