Calculinux Documentation

Official documentation for the Calculinux Linux distribution for PicoCalc.

About

This repository contains the source for the Calculinux documentation website, built with MkDocs and styled with the Material for MkDocs theme (configured to use Flatly color scheme).

Building the Documentation

Prerequisites

• Python 3.8 or higher
• pip

Installation

1. Clone this repository:

git clone https://github.com/Calculinux/docs.git
cd docs

2. Install dependencies:

pip install -r requirements.txt

Local Development

Serve the documentation locally with live reload:

mkdocs serve

Then open http://127.0.0.1:8000 in your browser.

Building Static Site

Build the static HTML site:

mkdocs build

The built site will be in the site/ directory.

Project Structure

docs/
├── mkdocs.yml              # MkDocs configuration
├── requirements.txt        # Python dependencies
├── docs/                   # Documentation source
│   ├── index.md           # Homepage
│   ├── stylesheets/       # Custom CSS
│   ├── getting-started/   # Getting started guides
│   ├── hardware/          # Hardware documentation
│   ├── user-guide/        # User guides
│   ├── developer/         # Developer documentation
│   ├── troubleshooting/   # Troubleshooting guides
│   ├── resources/         # External resources
│   └── about/             # About pages
└── README.md              # This file

Contributing

We welcome contributions to improve the documentation!

How to Contribute

1. Fork this repository
2. Create a branch for your changes
3. Make your edits in the docs/ directory
4. Test locally with mkdocs serve
5. Submit a pull request

Writing Guidelines

• Use clear, concise language
• Include code examples where appropriate
• Add screenshots/diagrams for visual concepts
• Follow the existing structure and style
• Test all commands and instructions
• Keep line length reasonable for readability

Markdown Features

This documentation supports:

• Standard Markdown
• Admonitions
• Code blocks with syntax highlighting
• Tables
• Task lists
• Icons and emojis

Deployment

The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.

Manual Deployment

To deploy manually:

mkdocs gh-deploy

License

This documentation is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).

See the LICENSE file for details.

Links

• Documentation Site: https://calculinux.github.io/docs/
• Main Project: https://github.com/Calculinux/meta-calculinux
• Forum: https://forum.clockworkpi.com/t/luckfox-lyra-on-picocalc/16280
• Issue Tracker: https://github.com/Calculinux/docs/issues

Support

• Open an issue for documentation bugs or improvements
• Visit the forum for general discussion
• See the main project README for Calculinux itself