Docs consolidation by kvnloo · Pull Request #51 · kvnloo/evolve

kvnloo · 2025-12-02T16:12:54Z

Description

Related Issues

Closes #
Related to #

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update
Refactoring (no functional changes)
Performance improvement
Test update

SPARC Methodology Checklist

Specification: Requirements clearly defined
Pseudocode: Algorithm/logic designed before implementation
Architecture: System design documented
Refinement: TDD approach - tests written first
Completion: Integration validated

Testing

Unit tests pass (npm test)
Integration tests pass
Manual testing completed
Code coverage maintained or improved

Test Coverage

Current coverage: XX%
Previous coverage: XX%
Change: +/- XX%

Code Quality

Linting passes (npm run lint)
Type checking passes (npm run typecheck)
No new warnings introduced
Code follows project style guide
Files under 500 lines (per style guide)

Security

No hardcoded secrets or credentials
No SQL injection vulnerabilities
Input validation implemented
Dependencies scanned for vulnerabilities
Audit logging added for sensitive operations

Documentation

README updated (if applicable)
API documentation updated (if applicable)
Comments added for complex logic
Context files updated (.claude/context/)
PRD updated (if applicable)

Multi-Agent Coordination

Agent coordination protocol followed
Git worktree used for parallel work
Memory hooks executed
No file conflicts with other agents
Session logs exported

Performance Impact

No performance degradation
Performance improved (describe how)
Performance impact acceptable and documented

Screenshots/Demo

Additional Notes

Reviewer Checklist

Dev

Bumps [actions/configure-pages](https://github.com/actions/configure-pages) from 4 to 5. - [Release notes](https://github.com/actions/configure-pages/releases) - [Commits](actions/configure-pages@v4...v5) --- updated-dependencies: - dependency-name: actions/configure-pages dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/github-script](https://github.com/actions/github-script) from 7 to 8. - [Release notes](https://github.com/actions/github-script/releases) - [Commits](actions/github-script@v7...v8) --- updated-dependencies: - dependency-name: actions/github-script dependency-version: '8' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [DavidAnson/markdownlint-cli2-action](https://github.com/davidanson/markdownlint-cli2-action) from 14 to 20. - [Release notes](https://github.com/davidanson/markdownlint-cli2-action/releases) - [Commits](DavidAnson/markdownlint-cli2-action@v14...v20) --- updated-dependencies: - dependency-name: DavidAnson/markdownlint-cli2-action dependency-version: '20' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v4...v5) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

…configure-pages-5 chore(deps): Bump actions/configure-pages from 4 to 5

…checkout-5 chore(deps): Bump actions/checkout from 4 to 5

…on/markdownlint-cli2-action-20 chore(deps): Bump DavidAnson/markdownlint-cli2-action from 14 to 20

…github-script-8 chore(deps): Bump actions/github-script from 7 to 8

Dev

- Resolved conflicts in .github/workflows/docs.yml - Updated actions/checkout to v5 (from dependabot) - Fixed Pipfile python_version to match workflow (3.11) Merges PR #38: Setup Sphinx documentation with revitron theme

MyST-Parser requires linkify-it-py when the linkify extension is enabled. This fixes the build error: 'Linkify enabled but not installed.'

The revitron-sphinx-theme was last updated in January 2023 and is not compatible with Sphinx 8.x. Pinning to Sphinx 5.3.x which is known to work with this theme.

- Sphinx ~=7.0 (stable, widely supported) - myst-parser ~=2.0 (compatible with Sphinx 7.x) - Keep revitron-sphinx-theme from GitHub This combination should resolve dependency conflicts.

Based on working FlowState implementation, the revitron theme requires html_context['style'] to be defined. This fixes the UndefinedError.

- Use Git installation for revitron-sphinx-theme (matches FlowState working config) - Remove version constraints from sphinx and myst-parser - Remove sphinx-rtd-theme (not needed with revitron)

- Update Python version to 3.12 (matching FlowState dev) - Add ref = "master" to revitron-sphinx-theme Git install - Update workflow to use Python 3.12 Based on FlowState's working docs/Pipfile configuration.

The build succeeds but has 263 warnings for missing cross-references. These are documentation quality issues, not build blockers. Removing -W (warnings as errors) to allow deployment to proceed.

- Update Sphinx conf.py copyright and author - Update README-draft.md developer attribution - Update claudedocs execution logs

- Change color_scheme from 'blue' to 'dark' - Remove custom nav header background (dark mode handles it)

Bumps [actions/stale](https://github.com/actions/stale) from 9 to 10. - [Release notes](https://github.com/actions/stale/releases) - [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md) - [Commits](actions/stale@v9...v10) --- updated-dependencies: - dependency-name: actions/stale dependency-version: '10' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 3 to 5. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@v3...v5) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4 to 6. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@v4...v6) --- updated-dependencies: - dependency-name: actions/setup-node dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-pages-artifact/releases) - [Commits](actions/upload-pages-artifact@v3...v4) --- updated-dependencies: - dependency-name: actions/upload-pages-artifact dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 4. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@v2...v4) --- updated-dependencies: - dependency-name: github/codeql-action dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

…odeql-action-4 chore(deps): Bump github/codeql-action from 2 to 4

…stale-10 chore(deps): Bump actions/stale from 9 to 10

…codecov-action-5 chore(deps): Bump codecov/codecov-action from 3 to 5

…setup-node-6 chore(deps): Bump actions/setup-node from 4 to 6

…upload-pages-artifact-4 chore(deps): Bump actions/upload-pages-artifact from 3 to 4

# Conflicts: # docs/README-draft.md

…into docs-consolidation

kvnloo and others added 30 commits November 2, 2025 22:52

Merge pull request #20 from kvnloo/dev

508e1c6

Dev

Merge pull request #24 from kvnloo/dependabot/github_actions/actions/…

2e1bd4b

…configure-pages-5 chore(deps): Bump actions/configure-pages from 4 to 5

Merge pull request #27 from kvnloo/dependabot/github_actions/actions/…

bd45fe2

…checkout-5 chore(deps): Bump actions/checkout from 4 to 5

Merge pull request #26 from kvnloo/dependabot/github_actions/DavidAns…

473a246

…on/markdownlint-cli2-action-20 chore(deps): Bump DavidAnson/markdownlint-cli2-action from 14 to 20

Merge pull request #25 from kvnloo/dependabot/github_actions/actions/…

c20109b

…github-script-8 chore(deps): Bump actions/github-script from 7 to 8

Merge pull request #28 from kvnloo/dev

2385d06

Dev

Merge dev into main: resolve conflicts and fix Python version

d16a970

- Resolved conflicts in .github/workflows/docs.yml - Updated actions/checkout to v5 (from dependabot) - Fixed Pipfile python_version to match workflow (3.11) Merges PR #38: Setup Sphinx documentation with revitron theme

fix: Add linkify-it-py dependency for MyST parser

20217ac

MyST-Parser requires linkify-it-py when the linkify extension is enabled. This fixes the build error: 'Linkify enabled but not installed.'

Update developer name in README.md

8beae15

fix: Pin Sphinx to 5.3.x for revitron theme compatibility

282d470

The revitron-sphinx-theme was last updated in January 2023 and is not compatible with Sphinx 8.x. Pinning to Sphinx 5.3.x which is known to work with this theme.

fix: Use compatible versions for revitron theme

ade3647

- Sphinx ~=7.0 (stable, widely supported) - myst-parser ~=2.0 (compatible with Sphinx 7.x) - Keep revitron-sphinx-theme from GitHub This combination should resolve dependency conflicts.

fix: Add required 'style' context for revitron theme

fe6b58b

Based on working FlowState implementation, the revitron theme requires html_context['style'] to be defined. This fixes the UndefinedError.

Fix revitron-sphinx-theme installation using Git method

1715c4f

- Use Git installation for revitron-sphinx-theme (matches FlowState working config) - Remove version constraints from sphinx and myst-parser - Remove sphinx-rtd-theme (not needed with revitron)

Match FlowState dev branch configuration for Sphinx

2cf9d24

- Update Python version to 3.12 (matching FlowState dev) - Add ref = "master" to revitron-sphinx-theme Git install - Update workflow to use Python 3.12 Based on FlowState's working docs/Pipfile configuration.

Remove -W flag from Sphinx build to allow warnings

2f96752

The build succeeds but has 263 warnings for missing cross-references. These are documentation quality issues, not build blockers. Removing -W (warnings as errors) to allow deployment to proceed.

Update author name from Kevin Loo to Kevin Rajan

5bf8591

- Update Sphinx conf.py copyright and author - Update README-draft.md developer attribution - Update claudedocs execution logs

Switch to dark mode theme for revitron

1d38f7a

- Change color_scheme from 'blue' to 'dark' - Remove custom nav header background (dark mode handles it)

Merge pull request #44 from kvnloo/dependabot/github_actions/github/c…

b9d2bd6

…odeql-action-4 chore(deps): Bump github/codeql-action from 2 to 4

Merge pull request #40 from kvnloo/dependabot/github_actions/actions/…

93430af

…stale-10 chore(deps): Bump actions/stale from 9 to 10

Merge pull request #41 from kvnloo/dependabot/github_actions/codecov/…

a769fac

…codecov-action-5 chore(deps): Bump codecov/codecov-action from 3 to 5

Merge pull request #42 from kvnloo/dependabot/github_actions/actions/…

47b1349

…setup-node-6 chore(deps): Bump actions/setup-node from 4 to 6

kvnloo and others added 4 commits November 26, 2025 12:50

Merge pull request #43 from kvnloo/dependabot/github_actions/actions/…

fe1e888

…upload-pages-artifact-4 chore(deps): Bump actions/upload-pages-artifact from 3 to 4

Merge branch 'dev'

1dd39c3

Merge remote-tracking branch 'origin/main' into docs-consolidation

42e8650

# Conflicts: # docs/README-draft.md

Merge branch 'docs-consolidation' of https://github.com/kvnloo/evolve …

8364e3f

…into docs-consolidation

github-actions bot added documentation Improvements or additions to documentation github-actions size/M labels Dec 2, 2025

kvnloo merged commit be0c258 into dev Dec 2, 2025
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Docs consolidation#51

Docs consolidation#51
kvnloo merged 34 commits intodevfrom
docs-consolidation

kvnloo commented Dec 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

kvnloo commented Dec 2, 2025

Description

Related Issues

Type of Change

SPARC Methodology Checklist

Testing

Test Coverage

Code Quality

Security

Documentation

Multi-Agent Coordination

Performance Impact

Screenshots/Demo

Additional Notes

Reviewer Checklist

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant