📚 Cidadão.AI - Documentation

Central documentation hub for Brazilian government transparency analysis project
Hub central de documentação para projeto de análise de transparência governamental brasileira

🌐 Live Documentation Hub

English | Português

---

🇺🇸 English

Quick Start

```bash

Clone and serve documentation locally

git clone https://github.com/anderson-ufrj/cidadao.ai-docs cd cidadao.ai-docs python -m http.server 8000

Open: http://localhost:8000

```

Features

• Central documentation hub for all Cidadão.AI repositories
• Bilingual support (PT-BR/EN-US) with theme switching
• Live API documentation integration
• Responsive design with Tailwind CSS
• Auto-deployed to GitHub Pages

Links

• 🌐 Documentation Hub: https://anderson-ufrj.github.io/cidadao.ai-docs/

---

🇧🇷 Português

Início Rápido

```bash

Clone e sirva documentação localmente

git clone https://github.com/anderson-ufrj/cidadao.ai-docs cd cidadao.ai-docs python -m http.server 8000

Abra: http://localhost:8000

```

Funcionalidades

• Hub central de documentação para todos os repositórios Cidadão.AI
• Suporte bilíngue (PT-BR/EN-US) com alternância de tema
• Integração de documentação de API ao vivo
• Design responsivo com Tailwind CSS
• Auto-deploy para GitHub Pages

Links

• 🌐 Hub de Documentação: https://anderson-ufrj.github.io/cidadao.ai-docs/

🏗️ Architecture

Core Components

• Frontend Interface: Modern, responsive documentation hub
• API Documentation: Integrated FastAPI/Swagger documentation
• Multi-language Support: Portuguese (PT-BR) and English (EN-US)
• Theme System: Light/dark mode with persistent user preferences

Tech Stack

• Frontend: HTML5, CSS3, JavaScript ES6+
• Styling: Tailwind CSS via CDN
• Icons: Emoji-based iconography
• Documentation: FastAPI/Swagger via iframe integration
• Deployment: GitHub Pages
• Fonts: Inter font family

🚀 Quick Start

Prerequisites

• Modern web browser (Chrome 90+, Firefox 88+, Safari 14+)
• Local web server (for development)

Local Development

1. Clone the repository bash git clone https://github.com/anderson-ufrj/cidadao.ai-docs.git cd cidadao.ai-docs

2. Serve locally ```bash

   Using Python

   python -m http.server 8000

# Using Node.js npx serve .

# Using PHP php -S localhost:8000 ```

1. Open in browser http://localhost:8000

GitHub Pages Deployment

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

📁 Project Structure

cidadao.ai-docs/ ├── index.html # Main documentation hub ├── openapi.json # API specification (auto-updated) ├── update-api-docs.sh # Manual update script ├── README.md # This file ├── LICENSE # MIT license ├── .github/ │ └── workflows/ │ └── update-api-docs.yml # Auto-update workflow └── assets/ # Static assets (if any)

🔄 API Documentation Updates

The API documentation is automatically updated through multiple mechanisms:

1. Live Documentation (Primary)

The documentation hub uses an iframe that loads the live API docs directly from Hugging Face, ensuring always up-to-date information.

2. Automated Updates (GitHub Actions)

• Daily Updates: Runs at 6 AM UTC (3 AM BRT)
• Manual Trigger: Can be triggered manually from GitHub Actions tab
• Webhook Support: Can be triggered from backend repository updates

3. Manual Updates

For local development or immediate updates: bash ./update-api-docs.sh

The workflow automatically: - Downloads the latest OpenAPI spec from the backend - Validates the JSON format - Commits changes only if the spec has been modified - Updates the documentation hub

🌐 Features

🎨 User Interface

• Responsive Design: Mobile-first approach with Tailwind CSS
• Theme Toggle: Light/dark mode with localStorage persistence
• Language Switch: PT-BR/EN-US with complete translations
• Smooth Navigation: Anchor-based scrolling with fixed header

📚 Documentation Sections

1. Repositories: Links to all official GitHub repositories
2. Important Links: Production deployments and resources
3. API Documentation: Live API docs via iframe integration
4. About Modal: Comprehensive project information

🔧 Technical Features

• Progressive Enhancement: Works without JavaScript
• Accessible Design: Semantic HTML with proper ARIA labels
• Performance Optimized: Minimal dependencies, CDN resources
• SEO Friendly: Proper meta tags and structured content

🔗 Related Repositories

| Repository | Description | Status | |------------|-------------|--------| | cidadao.ai-frontend | Next.js web application | ✅ Active | | cidadao.ai-backend | FastAPI backend system | ✅ Active | | cidadao.ia-models | ML models and scripts | 🔄 Development |

🤝 Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

Development Guidelines

1. Code Style: Follow existing HTML/CSS/JS patterns
2. Responsive Design: Test on multiple screen sizes
3. Accessibility: Maintain semantic HTML structure
4. Performance: Keep dependencies minimal
5. Internationalization: Update both PT-BR and EN-US translations

Reporting Issues

When reporting issues, please include: - Browser version and OS - Steps to reproduce - Expected vs actual behavior - Screenshots if applicable

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

👨‍💻 Author

Anderson Henrique da Silva
📧 andersonhs27@gmail.com | 💻 GitHub