FiNAN Documentation

This is a documentation site for the FiNAN (Filipino Nurses Association in the Nordic Region) website. It provides comprehensive guides for developers and content editors, covering technical implementation, content management, and security best practices for the main FiNAN website repository.

🎯 Purpose

Provide comprehensive documentation for two distinct audiences:

1. Developers - Technical contributors and new team members
2. Content Editors - Non-technical users managing content (committee members, FAQs, events)

🚀 Project Structure

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   └── docs/
│   │       ├── getting-started/
│   │       ├── core-concepts/
│   │       ├── components/
│   │       ├── content-management/
│   │       ├── integrations/
│   │       └── ...
│   ├── styles/
│   │   └── global.css
│   └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Important: All documentation files use .mdx extension (not .md) to support Starlight components.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
pnpm install	Installs dependencies
pnpm dev	Starts local dev server at localhost:4321
pnpm start	Alias for pnpm dev
pnpm build	Build your production site to ./dist/
pnpm preview	Preview your build locally, before deploying
pnpm astro check	Run TypeScript type checking
pnpm astro ...	Run CLI commands like astro add, astro check
pnpm astro -- --help	Get help using the Astro CLI

Note: Always use pnpm (not npm or yarn) for consistency.

📚 Documentation Structure

The documentation is organized into the following sections:

• Getting Started - Foundation and setup guides
• Core Concepts - TypeScript patterns, data management, asset handling
• Components - Reusable component documentation
• Content Management - Guides for non-technical editors
• Integrations - Ghost CMS, PhotoSwipe, and third-party services
• Pages - Page creation and structure
• SEO & Performance - Optimization techniques
• Security - Configuration and best practices
• Code Quality - Development workflow
• Deployment - Build and deployment guides
• Reference - Complete API reference
• Troubleshooting - Common issues and solutions
• Contributing - Community guidelines

🛠️ Tech Stack

• Astro 5.6.1 - Static site generator
• Starlight 0.37.3 - Documentation theme
• Tailwind CSS 4.1.18 - Styling framework
• Sharp 0.34.2 - Image optimization
• TypeScript - Strict type checking

📖 Contributing

Quick Start for Contributors

1. Clone the repository
2. Install dependencies: pnpm install
3. Start dev server: pnpm dev
4. Make changes to .mdx files in src/content/docs/
5. Run pnpm build to validate before committing
6. Submit a pull request

Documentation Guidelines

• Use .mdx extension for all documentation files
• Include required frontmatter (title and description)
• Use Starlight components (Steps, Card, Aside, etc.) appropriately
• Follow the dual-audience approach (developers and editors)
• Never include real credentials or sensitive data

🔗 Related Repositories

• Main FiNAN Website: https://github.com/finan-eu/finan-website

📝 License

This documentation is part of the FiNAN project.

👀 Learn More

• Starlight Documentation
• Astro Documentation
• Astro Discord Server