Skip to content

CI, GitHub Pages, and contributor templates - #11

Merged
elprofesoriqo merged 6 commits into
feat/sphinx-docsfrom
feat/github-ci
Sep 20, 2026
Merged

elprofesoriqo merged 6 commits into
feat/sphinx-docsfrom
feat/github-ci

Conversation

@elprofesoriqo

Copy link
Copy Markdown
Collaborator

Summary

  • GitHub Actions ci.yml: ruff, pytest, Sphinx HTML artifact.
  • docs.yml deploys GitHub Pages on push to main.
  • Issue/PR templates, CoC, CONTRIBUTING, and local scripts/verify_all.sh / verify_local.ps1.

Test plan

Checklist

  • One issue, one PR
  • Tests added or updated
  • Did not vendor a training algorithm (MAPPO / QMIX / CT-GMARL stay out of tree)
  • User-path docs updated only if the user path changed

Stacked on the Sphinx docs PR. Retarget to main after that merges. Enable Pages: Settings → Pages → Source → GitHub Actions.

elprofesoriqo and others added 3 commits September 20, 2026 15:15
Keep MAPPO/QMIX out of tree as a checklist item so PRs stay gym-scoped.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the old python-app workflow so PRs lint, test, and compile the site, and main publishes Pages.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document that ruff, fast pytest, and Sphinx -W are the merge bar.

Co-authored-by: Cursor <cursoragent@cursor.com>

@elprofesoriqo elprofesoriqo left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Reviewed CI / templates (3 commits). Merge last; then set Pages source to GitHub Actions.

Looks good

  • PRs build Sphinx HTML as a docs-html artifact; main deploys Pages.
  • Contributor checklist tells people not to vendor MAPPO/QMIX.

Should fix

  • .github/ISSUE_TEMPLATE/config.yml "Research backlog" points at RESEARCH.md on main, which does not exist. Use docs/research.md (404 otherwise).

Notes (non-blocking)

  • ci.yml still runs ruff check . on the whole simulator. Local scripts/verify_all.sh does the same. That will fail on pre-existing files until ruff is scoped or the old tree is cleaned.
  • CI pytest tests/ is the full suite; the local script uses -m fast. Call that out or align them.

url: https://reforcemind.github.io/NetForge_RL/
about: Getting started, Arena, questions, API.
- name: Research backlog
url: https://github.com/reforcemind/NetForge_RL/blob/main/RESEARCH.md

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

This URL 404s: there is no RESEARCH.md at the repo root. Point at docs/research.md (or drop the contact link).

elprofesoriqo and others added 3 commits September 20, 2026 15:22
Unindent the evaluate command in the docstring and construct FrameRecorder before asserting empty save.

Co-authored-by: Cursor <cursoragent@cursor.com>
Ruff 0.16 treats a bare ignore list as a much larger rule set, which fails on the existing simulator files.

Co-authored-by: Cursor <cursoragent@cursor.com>
Quote style is single, including fenced examples and the figure builder.

Co-authored-by: Cursor <cursoragent@cursor.com>
@elprofesoriqo
elprofesoriqo merged commit 4c8ea09 into feat/sphinx-docs Sep 20, 2026
3 checks passed
@elprofesoriqo
elprofesoriqo deleted the feat/github-ci branch September 20, 2026 13:30
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.

1 participant