Skip to content

akawaka/doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 Akawaka Documentation Hub

Built with Cecil Powered by Symfony Centralized Docs


🚀 Features at a Glance

  • Centralized Docs: All Akawaka project documentation in one place
  • Auto-Sync: Docs update automatically via GitHub Actions
  • Easy Config: Manage projects with simple YAML files
  • Fast Builds: Powered by Cecil for instant previews

🗺️ Quick Navigation

📝 Add Projects 🔄 Doc Sync 💻 Development
⚙️ Config 🏗️ Structure ✨ Benefits

📝 Add Projects

Manage projects via a single YAML file.

⚙️ Configuration File

  • Location: data/projects.yml
  • Purpose: Defines all projects shown on the homepage.

Fields

Field Description
title Display name (emojis supported)
description Short summary for the project card
url Link (relative for internal, absolute for external)
type internal or external
category For grouping (e.g., documentation, development)
featured true to show on homepage

Example Entry

- title: "📚 API Documentation"
  description: "Complete API reference for all Akawaka services."
  url: "/api/"
  type: "internal"
  category: "documentation"
  featured: true

➕ How to Add a Project

  1. Edit data/projects.yml
  2. Add a new entry (see above)
  3. Set featured: true to display on homepage
  4. Commit & push

🏗️ Project Structure

.
├── data/
│   └── projects.yml      # Project definitions
├── pages/                # Documentation pages
├── config.yml            # Cecil config
├── composer.json         # PHP dependencies
└── README.md             # This file

🔄 Automating Documentation Sync

  • Use GitHub Actions in your project repo to build and push docs here.
  • Target the correct subdirectory (e.g., /pages/opencode/).
  • Trigger a site build after syncing.

💻 Development

Built with Cecil (Symfony-based static site generator).

Install

composer install

Build

bin/cecil build

Outputs to _site/.

Local Dev

bin/cecil serve

Runs at http://localhost:8000 with hot reload.


✨ Benefits

  • Simple Management: Add/remove projects in YAML
  • Consistent Format: All projects follow the same structure
  • Flexible Display: Control homepage visibility
  • Versioned: All changes tracked in Git

For any Akawaka project, this hub is your go-to for documentation—fast, organized, and always up to date.

About

Documentation Hub for the Akawaka Team

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •