Skip to content

docs: add the mxcli language poster to the README and docs site - #1374

Merged
ako merged 3 commits into
mainfrom
feature/language-poster
Oct 10, 2026
Merged

ako merged 3 commits into
mainfrom
feature/language-poster

Conversation

@ako

@ako ako commented Oct 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds the mxcli language poster, all of mxcli and MDL on one page, to docs-site/src/poster/. mdBook copies it through unchanged, so the self-contained interactive HTML opens as a regular page at /mxcli/poster/mxcli-language-poster.html.
  • Adds a "The Language Poster" page under Preface (docs-site/src/preface/poster.md). It shows the poster image linking to the interactive version and links the full-resolution PNG for printing.
  • README: shows the poster at the top, linking to the published interactive version.
  • README: replaces the Playground link with the bootstrap prompt, the fastest way to spin up a Mendix project in a Claude Code cloud session.
  • The README and the docs page use a 2000 px copy of the image (371 KB) instead of the full-size 4 MB PNG.

Notes

  • The README poster link points to GitHub Pages, so it resolves once this merges and the docs workflow deploys.
  • Verified locally: mdbook build docs-site succeeds, and book/poster/ contains the HTML and both PNGs. The only build warning is about language/versions.md and was already there.
  • Docs only, no code changes.

🤖 Generated with Claude Code

https://claude.ai/code/session_014DfG9NpcA979LzU5R8j1Ay

ako and others added 3 commits October 10, 2026 11:39
The interactive poster (self-contained HTML) and its PNG snapshot live in
docs-site/src/poster/, so mdBook publishes them as-is and the HTML opens
as a regular page at /mxcli/poster/mxcli-language-poster.html. A new
preface page shows the PNG linking to it, and the README shows the PNG at
the top linking to the published version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014DfG9NpcA979LzU5R8j1Ay
The full-size PNG is 4 MB; the 2000px copy is 371 KB. The docs page links
the full-resolution file for printing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014DfG9NpcA979LzU5R8j1Ay
@github-actions

Copy link
Copy Markdown

AI Code Review

Review Summary

This PR adds documentation assets (the mxcli language poster) and updates links in the README and docs site. It contains no code changes—only documentation and asset additions. After reviewing against the provided checklist:

What Looks Good

  • Documentation placement: The poster is correctly added to docs-site/src/preface/poster.md (under Preface) and linked in SUMMARY.md, following the project's documentation structure for user manual content.
  • Asset optimization: Uses a 2000px PNG (371 KB) for web/display instead of the 4MB full-resolution version, with the full PNG available for printing—appropriate for documentation performance.
  • README improvements:
    • Replaces the generic Playground link with a targeted "bootstrap prompt" for Claude Code users (more relevant to the audience).
    • Features the poster prominently at the top with clear linking to the interactive version.
  • Verification: Confirmed local mdbook build succeeds with expected output in book/poster/.
  • Scope: Purely documentation-focused with no code changes—atomic and single-concern.

Checklist Compliance

  • Overlap/duplication: No existing proposals or features cover this documentation asset; no code duplication.
  • MDL syntax: Not applicable (no MDL changes).
  • Full-stack consistency: Not applicable (no MDL feature additions).
  • Test coverage: Not applicable (documentation-only).
  • Security & robustness:
    • HTML asset is self-contained interactive documentation (no external scripts/iframes noted in diff).
    • Image assets are standard PNGs; no risky file types.
    • Links point to official GitHub Pages (safe upon merge/deployment).
  • Scope & atomicity: Single concern (adding language poster); commits are not shown but PR description indicates cohesive documentation work.
  • Code quality: Documentation follows existing patterns; assets placed in correct directories.
  • Bugs/correctness: No code changes = no logic errors; documentation assets verified locally.

No Issues Found

  • Critical: None (no code changes, no security risks in assets).
  • Moderate: None (documentation is correctly scoped and placed).
  • Minor: None (all changes are appropriate and verified).

Recommendation

Approve the PR. The documentation additions are valuable, correctly implemented, and fully compliant with project guidelines. The poster enhances onboarding and reference for users without introducing any risk or maintenance burden.

Note: The README's bootstrap prompt link and poster integration align well with the project's focus on AI-assisted development (Claude Code etc.). The assets are optimized for web use while preserving print quality—a thoughtful touch.


Automated review via OpenRouter (Nemotron Super 120B) — workflow source

@ako
ako merged commit 700ddf8 into main Oct 10, 2026
33 checks passed
@ako
ako deleted the feature/language-poster branch October 10, 2026 13:05
ako added a commit that referenced this pull request Oct 15, 2026
fix: a note's line endings are not a change to a spliced flow (#1505)
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