diff --git a/.github/workflows/add-to-project.yml b/.github/workflows/add-to-project.yml deleted file mode 100644 index f2ca9ea..0000000 --- a/.github/workflows/add-to-project.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: Add to Project -on: - issues: - types: [opened] - pull_request: - types: [opened, ready_for_review] -permissions: - contents: read - issues: write - pull-requests: write - repository-projects: write -jobs: - add: - runs-on: ubuntu-latest - steps: - - uses: actions/add-to-project@v1 - with: - project-url: https://github.com/orgs/arras-labs/projects/1 - github-token: ${{ secrets.ADD_TO_PROJECT_PAT }} diff --git a/README.md b/README.md index e846ae8..6a346ad 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # Documentation -This repository will host organisation-wide documentation (e.g., MkDocs or Docusaurus). +## Overview +Central documentation for the organisation: architecture, ADRs, runbooks, and user guides. + +## Scope +- Developer and operator documentation +- Architecture Decision Records (ADRs) +- Public and internal guides + +## Tooling +TBD (e.g., Docusaurus or MkDocs) + +## Structure +- `docs/` site content (to be added) +- `docs/adr/` architecture decisions +- `static/` assets (if used by the site) + +## Local build +Depends on chosen site generator. Add commands once the tool is selected. + +## Contributions +Keep documentation in British English. Align updates with code changes.