Skip to content

Add docs badge and links to README - #192

Merged
berendkleinhaneveld merged 4 commits into
masterfrom
readme-docs-link
Jul 7, 2026
Merged

Add docs badge and links to README#192
berendkleinhaneveld merged 4 commits into
masterfrom
readme-docs-link

Conversation

@berendkleinhaneveld

@berendkleinhaneveld berendkleinhaneveld commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

The documentation is now live at https://fork-tongue.github.io/collagraph/, so link to it from the README:

  • A Docs badge next to the PyPI and CI badges, showing the status of the Docs workflow and linking to the live documentation site
  • A link to the documentation in the intro
  • A link to the guides/API reference next to the existing examples-folder pointer

Also includes two README refreshes:

  • Update the counter example to use text interpolation (<label>Count: {{ count }}</label>), matching examples/pyside/counter.cgx and the documentation
  • Remove the outdated mention of plain render functions: since the fine-grained reactivity overhaul, single-file components (.cgx) are the ergonomic way to write components

馃 Generated with Claude Code

berendkleinhaneveld and others added 4 commits July 7, 2026 23:27
The documentation is now live at https://fork-tongue.github.io/collagraph/
so link to it from the README: a Docs workflow badge next to the PyPI
and CI badges, plus links in the intro and examples sections.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Match examples/pyside/counter.cgx and the documentation, which use
text content with interpolation instead of the :text attribute.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Since the fine-grained reactivity overhaul, single-file components
(.cgx) are the ergonomic way to write components, so describe that as
the way to write interfaces and mention that reactivity is fine-grained.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@berendkleinhaneveld
berendkleinhaneveld merged commit c83966c into master Jul 7, 2026
9 of 10 checks passed
@berendkleinhaneveld
berendkleinhaneveld deleted the readme-docs-link branch July 7, 2026 21:38
berendkleinhaneveld added a commit that referenced this pull request Jul 21, 2026
Features:
- Add pure-Python view API as alternative to cgx templates (#193)
- Support text elements for PySide widgets that display text (#191)

Fixes & internals:
- Fragment parenting overhaul (#162)
- Fix PyInstaller hook for CGX files inside packages (#184)
- Write compiled AST to temp file when CGX_DEBUG is set (#175)

Performance:
- Speed up mount path: cheap arity check, reuse first(), leaner emit (#186)
- Cache Fragment._component_parent() lookups (#187)
- Avoid redundant anchor lookups in Fragment.anchor() and unkeyed v-for (#188)

Documentation:
- Add MkDocs documentation with GitHub Pages deployment (#176)
- Add internals architecture documentation page (#194)
- Add docs badge and links to README (#192)

Tooling & CI:
- Add benchmark suite and per-PR benchmark CI workflow (#185)
- Make benchmark CI guard robust against run-to-run noise (#196)
- Update GitHub actions from Node 20 to Node 24 (#190)
- Migrate from pre-commit to prek (#195)

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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