Repository navigation
docs: add project documentation and fix inaccuracies - #30
Merged
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
New files:
docs/quickstart.md— 5-minute getting started guidedocs/FAQ.md— 30+ common questions with answersdocs/examples.md— In-depth walkthrough ofexamples/hello/docs/command-line-reference.md— Full option referencedocs/DOCUMENTATION_PLAN.md— Roadmap for remaining docsAGENTS.md— Repository guidelines for contributors/agentsModified:
README.md— Fix--target=opt,static(static is not a built-in variant)Deleted:
docs/PHASE1_COMPLETE.md— Contained false claims (e.g.,hello.mmexpanded to 266 lines when it is 71,--guidecommand added when it was not)Fixes:
--guideflag (never implemented)--target=static— not a built-in variant; nomake/targets/static.mmexists. Omitsharedto get static-only buildsclean,tidy,tests.cleanall existexamples/prep/description (test dependencies, not preprocessing)mm_prefixnotMM_PREFIX)--palette=darkfrom CLI referencemm <project>.help,mm <asset>.info) instead of non-existent--guide