Skip to content

26T1-DOC-RL-001 | Cleanup documentation#219

Open
liyunze-coding wants to merge 2 commits into
mainfrom
chore/docs-cleanup
Open

26T1-DOC-RL-001 | Cleanup documentation#219
liyunze-coding wants to merge 2 commits into
mainfrom
chore/docs-cleanup

Conversation

@liyunze-coding
Copy link
Copy Markdown
Collaborator

Summary

Clean up documentation so every documentation are in the docs folder.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Refactor / code cleanup
  • Documentation
  • CI/CD / infrastructure
  • Security

Affected Components

  • /backend-api
  • /frontend
  • /engine (collectors / policies)
  • /security
  • /infrastructure
  • /.github/workflows
  • /docs

Motivation

Planner Task

Testing Done

  • Unit tests pass locally
  • Tested manually — describe how:
  • No tests required — explain why: Markdown only, no tests required

Security Considerations

No security considerations.

Breaking Changes

  • No breaking changes
  • Yes — describe below:

Rollback Plan

  • Revert commit is sufficient
  • Requires additional steps — describe below:

Checklist

  • Code follows project conventions
  • No secrets, credentials, or tokens committed
  • Relevant documentation updated (if applicable)
  • CI/CD workflows pass on this branch
  • PR is focused on one thing

@liyunze-coding liyunze-coding changed the title Cleaned up docs 26T1-DOC-RL-001 | Cleanup documentation May 8, 2026
Comment thread docs/devops/automated-security-scan.md Outdated
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this file might need to be deleted, or at least some of the contents pasted into a broader 'workflows documentation file' which briefly goes over what workflows we have set up and running. I sorta have something similar to this in my ci-cleanup-v2 branch

@6igby
Copy link
Copy Markdown
Collaborator

6igby commented May 9, 2026

Apart from my comment it looks good to me, more clarity on where the files live :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants