Skip to content

Comments

Add MkDocs docs site#125

Merged
strawgate merged 6 commits intomainfrom
main-3aa341b1eb8b467d
Feb 19, 2026
Merged

Add MkDocs docs site#125
strawgate merged 6 commits intomainfrom
main-3aa341b1eb8b467d

Conversation

@github-actions
Copy link
Contributor

Summary

  • add MkDocs configuration and initial docs content
  • add docs requirements plus Makefile targets for serving/building
  • add a GitHub Pages workflow stub under github/workflows/mkdocs.yml (needs to be moved into .github/workflows/ by a maintainer)

Testing

AI generated by Issue Assistant

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@strawgate strawgate marked this pull request as ready for review February 19, 2026 05:12
Copy link
Contributor Author

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Approve.


What is this? | From workflow: PR Review Agent

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #125

Copy link
Contributor Author

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Request changes.


What is this? | From workflow: PR Review Agent

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #125

@@ -0,0 +1,45 @@
name: Docs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

[MEDIUM] Workflow location prevents execution

GitHub only loads workflows from .github/workflows/. With this file under github/workflows/, the docs workflow will never run, so Pages won't be built; move it to .github/workflows/mkdocs.yml before merge.

@github-actions
Copy link
Contributor Author

CI failed in Verify compiled workflows because make compile leaves the working tree dirty; the compiled workflow lock files are out of date.

Recommended fix:

  • Run make compile and commit the resulting updates under .github/workflows/ (the lock files + agentics-maintenance.yml, and the newly generated trigger-release-update.yml if it appears).
Log evidence
Working tree dirty after make compile.
 M .github/workflows/agentics-maintenance.yml
 M .github/workflows/gh-aw-agent-efficiency.lock.yml
 M .github/workflows/gh-aw-breaking-change-detect.lock.yml
 M .github/workflows/gh-aw-bug-hunter.lock.yml
 M .github/workflows/gh-aw-code-simplifier.lock.yml
 M .github/workflows/gh-aw-docs-drift.lock.yml
 M .github/workflows/gh-aw-docs-new-contributor-review.lock.yml
 M .github/workflows/gh-aw-downstream-health.lock.yml
 M .github/workflows/gh-aw-issue-triage.lock.yml
 M .github/workflows/gh-aw-mention-in-issue.lock.yml
 M .github/workflows/gh-aw-mention-in-pr.lock.yml
 M .github/workflows/gh-aw-pr-checks-fix.lock.yml
 M .github/workflows/gh-aw-pr-review.lock.yml
 M .github/workflows/gh-aw-project-summary.lock.yml
 M .github/workflows/gh-aw-semantic-function-clustering.lock.yml
 M .github/workflows/gh-aw-small-problem-fixer.lock.yml
 M .github/workflows/gh-aw-stale-issues.lock.yml
 M .github/workflows/gh-aw-test-improvement.lock.yml
 M .github/workflows/gh-aw-upgrade-check.lock.yml
 ?? .github/workflows/trigger-release-update.yml

Tests: Not run locally (log inspection only).


What is this? | From workflow: PR Checks Fixer

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@strawgate
Copy link
Collaborator

/ai let's refactor the existing docs into these instead of having two sets of readmes/docs

Let's put the meat under docs and the root readme in the repo links to the docs site and provides high level information. The nested readmes we should consider either getting rid of or simplifying.

Copy link
Contributor Author

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Approve.


What is this? | From workflow: PR Review Agent

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #125

@strawgate
Copy link
Collaborator

/ai let's refactor the existing docs into these instead of having two sets of readmes/docs

Let's put the meat under docs and the root readme in the repo links to the docs site and provides high level information. The nested readmes we should consider either getting rid of or simplifying.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Contributor Author

Refactored the detailed README content into the MkDocs pages and slimmed the root/section READMEs to point at the docs site. Updated the docs index with the approach comparison and links. Tests: make lint.


What is this? | From workflow: PR Assistant

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #125

@cla-checker-service
Copy link

❌ Author of the following commits did not sign a Contributor Agreement:
, 0aea2db

Please, read and sign the above mentioned agreement if you want to contribute to this project

@strawgate strawgate merged commit b57e640 into main Feb 19, 2026
1 check failed
@strawgate strawgate deleted the main-3aa341b1eb8b467d branch February 19, 2026 19:17
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.

Add mkdocs site

1 participant