Skip to content

feat(diagram): cleaner README graph — internal-only, self-doc note, source links#75

Merged
zaebee merged 3 commits into
mainfrom
feat/better-readme-graph
Jun 8, 2026
Merged

feat(diagram): cleaner README graph — internal-only, self-doc note, source links#75
zaebee merged 3 commits into
mainfrom
feat/better-readme-graph

Conversation

@zaebee

@zaebee zaebee commented Jun 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Fix --internal-only: was leaking virtual placeholder nodes (list.extend, str.endswith, etc.) because the resolver gives them FQNs like cgis.pipeline.list.extend (INTERNAL namespace). Now also excludes nodes with VIRTUAL_FILE_PATH.
  • Self-doc note in README: > Auto-generated by CGIS parsing its own source — the tool documents itself.
  • Node reference table with clickable GitHub links (src/cgis/pipeline.py#L47) auto-generated below the diagram.
  • --path-prefix arg for inject_readme_graph.py so URL paths are correct when ingesting from ./src.
  • autodoc workflow now passes --internal-only, --db, --fqn, --depth, --path-prefix to the relevant steps.

Test plan

  • make type-check && make pytest — 226 passed
  • Mermaid diagram in README shows only real source nodes (no extend, add, endswith junk)
  • Node table links point to https://github.com/zaebee/codegraph-brain/blob/main/src/cgis/...
  • Trigger autodoc workflow manually after merge to verify end-to-end

…inks

- Fix _filter_internal to exclude virtual placeholder nodes (VIRTUAL_FILE_PATH),
  so --internal-only shows only symbols with real source files
- Add self-doc note and node reference table with GitHub links to inject_readme_graph.py
- Add --path-prefix arg to inject_readme_graph.py for correct repo-relative URLs
- Enable --internal-only in autodoc workflow for the pipeline flow diagram

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

zaebee and others added 2 commits June 8, 2026 20:53
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@sonarqubecloud

sonarqubecloud Bot commented Jun 8, 2026

Copy link
Copy Markdown

@zaebee zaebee merged commit d864986 into main Jun 8, 2026
3 checks passed
@zaebee zaebee deleted the feat/better-readme-graph branch June 8, 2026 21:00
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