Skip to content

docs: add manual StockFit review guide - #4

Open
FLABDUL wants to merge 1 commit into
mainfrom
codex/manual-review-docs
Open

FLABDUL wants to merge 1 commit into
mainfrom
codex/manual-review-docs

Conversation

@FLABDUL

@FLABDUL FLABDUL commented Sep 29, 2026

Copy link
Copy Markdown
Owner

Summary

  • add Windows-focused developer setup and architecture overview to the main README
  • expand the StockFit learning guide into a structured code-level review with diagrams, breakpoints and exercises
  • add reusable VS Code launch configurations for the offline demo, audit and tests
  • document the existing native-Windows Sphinx filename collision and the WSL/Linux CI workaround

Verification

  • 424 tests passed, 3 skipped, 12 deselected
  • 164 focused StockFit tests passed
  • Ruff formatting and lint checks passed
  • Pyrefly reported 0 errors
  • offline demo and audit produced the expected derived outputs
  • VS Code JSON and local Markdown links validated

Known limitation

Native Windows Sphinx builds still fail because generated Cash and cash API stub filenames collide on a case-insensitive filesystem. This pre-existing issue is now documented; the documentation gates should run in WSL or Linux CI.

@FLABDUL
FLABDUL deployed to github-pages September 29, 2026 21:34 — with GitHub Actions Active

This branch was successfully deployed

1 active deployment
github-pages — f20e5554 Deployed Sep 29, 2026 by FLABDUL via Build docs #6
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