Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Approve.
What is this? | From workflow: PR Review Agent
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #125
There was a problem hiding this comment.
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 | |||
There was a problem hiding this comment.
[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.
|
CI failed in Recommended fix:
Log evidenceTests: 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. |
|
/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. |
There was a problem hiding this comment.
Approve.
What is this? | From workflow: PR Review Agent
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #125
|
/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>
|
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: What is this? | From workflow: PR Assistant Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #125 |
|
❌ Author of the following commits did not sign a Contributor Agreement: Please, read and sign the above mentioned agreement if you want to contribute to this project |
Summary
github/workflows/mkdocs.yml(needs to be moved into.github/workflows/by a maintainer)Testing
make lintmkdocs build --strict(via a temporary venv)Fixes Add mkdocs site #114