Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 11, 2025

Consolidates scattered documentation files into a hierarchical docs/ structure suitable for GitHub Pages deployment.

Changes

File Organization

  • Moved 40 markdown files from website/documents/, ansible/, BACON/, and issues/ into categorized subdirectories
  • Kept standard files (CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE.md, SECURITY.md) in root directory per GitHub conventions
  • Created 8 logical categories: community/ (links to root), setup/, architecture/, features/, pages/, development/, troubleshooting/, legal/
  • Each subdirectory contains a README for navigation context

Static Content Extraction

  • Extracted Terms of Service from website/templates/mobile_terms.html to docs/legal/terms-of-service.md
  • Extracted Privacy Policy from website/templates/mobile_privacy.html to docs/legal/privacy-policy.md
  • Created markdown documentation for legal pages that were previously only in HTML templates

GitHub Pages Configuration

  • docs/index.md - Central navigation hub linking all documentation sections
  • docs/_config.yml - Jekyll configuration with Cayman theme
  • .github/workflows/deploy-docs.yml - Auto-deployment on docs/ changes

Reference Updates

  • Updated links in root README.md, .github/copilot-instructions.md, and website/templates/includes/sidenav.html
  • All references now point to correct locations (root for standard files, docs/ for project documentation)
  • Changed documentation URL from individual file links to https://owasp-blt.github.io/BLT/

Structure

Root Directory (standard files per GitHub conventions)
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
└── SECURITY.md

docs/
├── index.md
├── community/      # Links to root standard files
├── setup/          # Installation guides, bot setup, webhooks, Ansible
├── architecture/   # System design, mermaid diagrams, proposals
├── features/       # Feature docs, GitHub Actions, BACON, file reference
├── pages/          # 24 page-specific UI documentation files
├── legal/          # Terms of Service, Privacy Policy (extracted from templates)
├── development/    # Developer workflow guides
└── troubleshooting/

Enables browsable documentation site once GitHub Pages is enabled in repository settings.

Original prompt

Look at all pages in this project and if they can be moved into docs then do that also organize the docs folder so it works as a documentation github pages app


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 11, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI and others added 2 commits December 11, 2025 07:30
Co-authored-by: DonnieBLT <128622481+DonnieBLT@users.noreply.github.com>
Co-authored-by: DonnieBLT <128622481+DonnieBLT@users.noreply.github.com>
Copilot AI changed the title [WIP] Move project pages to docs folder and organize structure Reorganize documentation into structured docs/ folder for GitHub Pages Dec 11, 2025
Copilot AI requested a review from DonnieBLT December 11, 2025 07:37
@DonnieBLT
Copy link
Collaborator

@copilot lets keep the standard files in their place - also look through the website regular pages and anything mostly static can go here

…ages

Co-authored-by: DonnieBLT <128622481+DonnieBLT@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 11, 2025

@copilot lets keep the standard files in their place - also look through the website regular pages and anything mostly static can go here

Done! Standard files (CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE.md, SECURITY.md) are now back in the root directory. I've also extracted static content from the Terms and Privacy pages in website/templates/ and created markdown versions in docs/legal/:

  • docs/legal/terms-of-service.md - Terms and conditions
  • docs/legal/privacy-policy.md - Privacy policy

All references throughout the codebase have been updated to point to the correct locations. Commit: 8525086

@github-actions github-actions bot added last-active: 0d PR last updated 0 days ago last-active: 2d PR last updated 2 days ago and removed last-active: 0d PR last updated 0 days ago labels Dec 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

last-active: 2d PR last updated 2 days ago

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

2 participants