This repository contains the source code for the TIG documentation website.

tig-docs uses Nextra, a static site generation framework for Next.js. It allows us to write and maintain the documentation in markdown and MDX, with the ability to use custom Next.js components.

To install all the dependencies, run:

pnpm install

To start a local development server on port 3000, run:

pnpm dev

To start the development server using docker:

docker-compose up --build

The documentation is structured as follows:

.
├── components
│   ├── ...
├── pages
│   ├── _app.js
│   ├── _meta.js
│   ├── index.mdx
│   ├── mechanism.mdx
│   ...
├── static
│   ├── ...
├── styles
│   ├── global.css
│   ├── ...
.

• You can edit or add new MDX files within the pages directory to edit or create new pages. Each MDX file should contain a frontmatter block at the top of the file with the title and description of the page.

  Example:

  ---
  title: "Token Holders"
  description: "Getting Started with TIG"
  ---
  
  # Token Holders
  ...

  Nextra comes with a lot of built-in components that you can use in your markdown files. You can also create custom components in the components directory.

• _meta.js contains the sidebar configuration for the documentation.

• /static contains all the static assets used in the documentation.

• /styles contains global styles and fonts.

• The components directory contains custom components used in the documentation.

• cspell.json contains all the words that are ignored by the spell checker.

You can submit an issue if you find any errors or have suggestions for improvements. You can submit an issue for:

• Typos or bugs in the documentation.
• Suggestions for new content.
• Suggestions for improvements to existing content.

To contribute to the documentation, please follow the steps below:

1. Fork the repository.

2. Switch to the staging branch.

3. Commit and push your changes to your fork.

4. Run pnpm spellcheck to check for spelling errors. If there are any errors, you can add the words to the cspell.json file.

5. Make a pull request to the staging branch of this repository. Make sure to include a detailed description of the changes you made.

This project is licensed under the MIT License.