Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ ssl/certs/
*.swp
*.swo
*~

# Documentation sources live on the host only; the site publishes the generated
# pages from forail-platform.github.io.
docs/
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Contributing to Forail Platform

This repository is the canonical home of the **full contributing guide** for the whole Forail Platform project — git workflow, commit conventions, coding standards, PR process across all repos.
The **full contributing guide** — git workflow, commit conventions, coding standards, PR process across all repos — is published on the developer docs site.

**Read first:** [docs/10-contributing-guide.md](./docs/10-contributing-guide.md)
**Read first:** <https://forail-platform.github.io/dev/contributing.html>

The markdown sources for that site are kept outside this repository.

## What lives here

- Docker Compose deployment stack (production and development overlays)
- Install scripts and bootstrap
- Cross-repo documentation (architecture, deployment, ops, contributing)
- Release notes for the platform as a whole

## Quick start (deploy stack)
Expand All @@ -20,7 +21,7 @@ cp .env.example .env
docker compose up -d
```

See [README.md](./README.md) and `docs/` for full setup.
See [README.md](./README.md) for full setup.

## Reporting bugs

Expand Down
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,31 +88,24 @@ forail-devops/
├── receptor/ # Receptor mesh configuration
├── scripts/ # Backup, restore, health checks
├── settings/ # Django production settings
├── docs/ # All documentation
├── .env.example # Environment template
└── .github/workflows/ # GitHub Actions CI/CD
```

## Documentation

### Deployment
- [Architecture Overview](docs/01-architecture-overview.md)
- [Docker Deployment](docs/07-docker-deployment.md)
- [CI/CD Pipeline](docs/08-ci-cd-pipeline.md)
- [CI Pipeline Reference](docs/ci-pipeline-reference.md)
- [Contributing Guide](docs/10-contributing-guide.md)

### Plans
- [Separation Plan](docs/plan_separation.md)
- [Development Plan](docs/plan_development.md)
- [Detailed Plan](docs/plan_detailed.md)
- [Future Development](docs/future_development_plan.md)
- [Chat/AI Assistant Plan](docs/chat_plan.md)
- [Mobile App Plan](docs/mobile_plan.md)
Published on the developer and user docs site — the markdown sources are kept
outside this repository:

- [Architecture Overview](https://forail-platform.github.io/docs/architecture.html)
- [Docker Deployment](https://forail-platform.github.io/docs/deployment.html)
- [CI/CD Pipeline](https://forail-platform.github.io/dev/ci-cd.html)
- [Contributing Guide](https://forail-platform.github.io/dev/contributing.html)
- [User Handbook](https://forail-platform.github.io/docs/user-handbook.html)
- [Administrator Handbook](https://forail-platform.github.io/docs/admin-handbook.html)

### Release
- [Release Notes v2026.03.0](docs/RELEASE_NOTES_v2026.03.0.md)
- [Start & Run Guide](docs/startrun.md)
- [Release notes](https://forail-platform.github.io/docs/) — one page per release

## Backup & Restore

Expand Down
158 changes: 0 additions & 158 deletions docs/00-platform-architecture.md

This file was deleted.

Loading
Loading