Repository navigation
Inkforge v0.1.4
What is new in v0.1.4
A documentation release: the repository now describes what the code actually does.
README and repository presentation
- Root
README.mdrewritten to the Standard Readme order: dynamic badges only (CI, CodeQL, OpenSSF Scorecard, release, license), table of contents, Quick Start, Install and Run Options, fullgenerate/publish/listflag tables, every environment variable the code reads, Mermaid pipeline diagram, LLM fallback chains as implemented, Supported Platforms table and an honest Status and Roadmap section (#62) packages/cli/README.mdandpackages/core/README.mdrewritten against the source; newapps/web/README.mdanddocs/README.mdindex (#62)docs/assets/demo.svg: a realinkforge generaterun recorded with asciinema and rendered with svg-term;docs/assets/social-preview.{html,png}for the repository social preview (#62)- One short description everywhere (README,
package.json,apps/web/package.json, GitHub About), 20 descriptive GitHub topics, andinkforge --helpnow prints the CLI package description instead of the old "human-readable MDX" tagline (#62)
Documentation corrections from review
--titlesemantics,pnpm lint(no linter wired up),make cilocal audit is advisory, the web app writes relative toapps/web, Dev.to tag drop rule,--platform substackrejection, Node 20.9 floor from Next.js 16, Commander exit codes, Makefile.envparsing,make publish-statusscopeSECURITY.md,CONTRIBUTING.md,docs/architecture.mdanddocs/publishing.mdaligned with the code
Known issues
emitoverwrites the generated article with the raw input whenINKFORGE_CONTENT_DIRdoes not end inarticles(#63)inkforge generatedoes not exit in an interactive terminal because the stage spinner is never stopped- The CI dependency audit is still red on the
apps/webadvisories listed under v0.1.3; Dependabot #59/#60 (next16.3.8) are pending
Full changelog: https://github.com/sairam0424/Inkforge/blob/main/CHANGELOG.md
Compare: v0.1.3...v0.1.4