Skip to content

Rewrite README as a getting started guide#241

Merged
kaja-s merged 3 commits into
mainfrom
fix/codeplain-docs
Jul 7, 2026
Merged

Rewrite README as a getting started guide#241
kaja-s merged 3 commits into
mainfrom
fix/codeplain-docs

Conversation

@kaja-s

@kaja-s kaja-s commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Replace the outdated clone + pip install -r requirements.txt flow with the current curl .../install.sh / irm .../install.ps1 installer (matches install/bash/install.sh and the codeplain CLI entry point).
  • Restructure Getting Started as a 3-step guide: install the CLI, install agent skills (npx plain-forge install), then render specs (codeplain your-project.plain).
  • Refresh the intro copy to describe *codeplain as a spec-centric platform for coding agents, not just a code renderer.
  • Add VS Code/Cursor extension, Discord, and support links; drop the stale "Releasing" (maintainer-only) and doc links that pointed to removed pages.
  • Update example links to the pong and task-manager examples in plainlang-examples, and add Flutter to the sample-project languages list.

@kaja-s kaja-s requested a review from dusano July 6, 2026 21:48
Comment thread README.md Outdated
kaja-s added 3 commits July 7, 2026 12:48
Replace the outdated clone+pip install flow with the current uv-based
installer, add the 3-step spec-driven workflow, and refresh the intro
copy and example links to match the current *codeplain platform.
@kaja-s kaja-s force-pushed the fix/codeplain-docs branch from a2564e1 to aeb7315 Compare July 7, 2026 10:51
@kaja-s kaja-s merged commit 407e94e into main Jul 7, 2026
10 checks passed
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.

2 participants