Skip to content

Improve researcher documentation entrypoint - #71

Merged
joanjcaceres merged 6 commits into
mainfrom
codex/researcher-docs-entrypoint
Jun 5, 2026
Merged

Improve researcher documentation entrypoint#71
joanjcaceres merged 6 commits into
mainfrom
codex/researcher-docs-entrypoint

Conversation

@joanjcaceres

@joanjcaceres joanjcaceres commented May 31, 2026

Copy link
Copy Markdown
Owner

Summary

  • Refactor the internal BBQ linear solve into readable stages that mirror the matrix quantization derivation: frozen-variable Schur reduction, positive-capacitance projection, free-coordinate charge-sector reduction, final frequency eigenproblem, and branch ZPF calculation.
  • Add BBQ Implementation Notes mapping the derivation and notation directly to the current helper stages in sccircuits/bbq.py.
  • Add BBQ Validation documenting code-backed trust checks from tests/test_bbq.py: LC units/ZPF, generalized eigenproblem normalization, frozen-coordinate reconstruction, free/zero-potential reduction, null capacitance, branch sign, and cQEDraw row order.
  • Expose the trust pages through MkDocs navigation, the BBQ overview, examples page, and README starting points.
  • Clarify that the configured GitHub Pages URL is not considered launched until it returns 200 OK after the Pages deployment is merged/enabled.

Closes #70

Launch / discoverability checklist

  • Merge the documentation deployment workflow to main.
  • Ensure GitHub Pages is enabled for the repository.
  • Verify https://joanjcaceres.github.io/sccircuits/ returns 200 OK after deployment.
  • Add the same URL to the GitHub repository sidebar website field.
  • Confirm README and pyproject.toml point to the live documentation URL.

Verification

  • pixi run -e sccircuits docs-build
  • pixi run -e sccircuits test
  • pixi run -e sccircuits typecheck
  • pixi run -e sccircuits lint
  • git diff --check

Notes

  • The current public docs URL returned 404 before this PR was merged/deployed, so the final URL check remains a post-merge deployment step.
  • The untracked top-level test_bbq.py in the local worktree was not included.

@joanjcaceres joanjcaceres added the documentation Improvements or additions to documentation label May 31, 2026
@joanjcaceres

Copy link
Copy Markdown
Owner Author

Process note: attempted to request GitHub Copilot review with gh pr edit 71 --add-reviewer "@copilot" using /opt/homebrew/bin/gh version 2.79.0, but GitHub returned @copilot not found; retrying as copilot also returned copilot not found. Review request is therefore not attached.

@joanjcaceres
joanjcaceres merged commit 8db5804 into main Jun 5, 2026
1 check passed
@joanjcaceres
joanjcaceres deleted the codex/researcher-docs-entrypoint branch June 5, 2026 06:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make SCCircuits documentation discoverable for researchers

1 participant