8000 docs: add project documentation and fix inaccuracies by rapa-mit · Pull Request #30 · aivazis/mm · GitHub
[go: up one dir, main page]

Skip to content

docs: add project documentation and fix inaccuracies - #30

Merged
aivazis merged 1 commit into
aivazis:mainfrom
Radovitzky-Group:docs-cleanup
Feb 18, 2026
Merged

aivazis merged 1 commit into
aivazis:mainfrom
Radovitzky-Group:docs-cleanup

Conversation

@rapa-mit
Copy link
Copy Markdown
Contributor

Summary

  • Add comprehensive documentation for mm: quickstart guide, FAQ (30+ questions), examples walkthrough, command-line reference, and repository guidelines (AGENTS.md)
  • Fix several factual errors carried over from earlier drafts

Changes

New files:

  • docs/quickstart.md — 5-minute getting started guide
  • docs/FAQ.md — 30+ common questions with answers
  • docs/examples.md — In-depth walkthrough of examples/hello/
  • docs/command-line-reference.md — Full option reference
  • docs/DOCUMENTATION_PLAN.md — Roadmap for remaining docs
  • AGENTS.md — Repository guidelines for contributors/agents

Modified:

  • README.md — Fix --target=opt,static (static is not a built-in variant)

Deleted:

  • docs/PHASE1_COMPLETE.md — Contained false claims (e.g., hello.mm expanded to 266 lines when it is 71, --guide command added when it was not)

Fixes:

  • Remove all references to phantom --guide flag (never implemented)
  • Correct --target=static — not a built-in variant; no make/targets/static.mm exists. Omit shared to get static-only builds
  • Fix FAQ claim "mm doesn't have a clean target" — clean, tidy, tests.clean all exist
  • Fix examples/prep/ description (test dependencies, not preprocessing)
  • Fix environment variable case in AGENTS.md (mm_prefix not MM_PREFIX)
  • Fill placeholder text in FAQ (issue tracker links)
  • Remove undocumented --palette=dark from CLI reference
  • Point help references to runtime targets (mm <project>.help, mm <asset>.info) instead of non-existent --guide

Add comprehensive documentation for mm:
- quickstart guide, FAQ, examples walkthrough, command-line reference
- AGENTS.md with repository guidelines

Fix factual errors in documentation:
- remove phantom --guide flag (never implemented in mm.py or mm)
- remove PHASE1_COMPLETE.md (contained false claims)
- correct --target=static (not a built-in variant; omit shared instead)
- fix FAQ claim that mm has no clean target (clean, tidy, tests.clean exist)
- fix examples/prep description (test dependencies, not preprocessing)
- fix environment variable case in AGENTS.md (mm_prefix, not MM_PREFIX)
- fill placeholder text in FAQ (contact/issue tracker info)
- remove undocumented --palette=dark f
7AF1
rom CLI reference
- update DOCUMENTATION_PLAN.md to reflect actual state
@aivazis
aivazis merged commit 5c2fa28 into aivazis:main Feb 18, 2026
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

0