Skip to content

docs: reorganize README as feature showcase with side-by-side comparison#35

Merged
e6qu merged 1 commit intodevfrom
docs/readme-overhaul
Mar 22, 2026
Merged

docs: reorganize README as feature showcase with side-by-side comparison#35
e6qu merged 1 commit intodevfrom
docs/readme-overhaul

Conversation

@e6qu
Copy link
Copy Markdown
Owner

@e6qu e6qu commented Mar 22, 2026

Summary

Reorganizes docs so README.md is the main entry point with a feature showcase, and FRANKENCODE.md is the technical reference.

README.md (new structure):

  • Feature comparison table (OpenCode vs Frankencode)
  • Tab bar showcase with keybinding table
  • Context editing overview
  • Slash commands table
  • Architecture diagram
  • Documentation index (links to detailed docs)

FRANKENCODE.md (slimmed down):

  • Technical diff only: modules, tools, agents, schema, pipeline, keybindings, type safety, bugs
  • No duplicate overview content — links back to README for feature showcase
  • No duplicate doc index — single index lives in README

Cross-linking:

  • 8 docs link to FRANKENCODE.md for technical details
  • README links to all docs via the documentation table
  • No content duplicated between files

Test plan

  • All cross-links verified (grep for FRANKENCODE, README references)
  • No stale references to deleted files
  • No duplicated content between README and FRANKENCODE

- README.md is now the main entry point: feature comparison table,
  tab bar showcase, context editing overview, slash commands, architecture
- FRANKENCODE.md is the technical reference: modules, tools, agents,
  schema, pipeline, keybindings, type safety, bug fixes
- No duplicated content between the two files
- All cross-links verified (8 docs link to FRANKENCODE.md, README links to all)
@e6qu e6qu merged commit 28114ca into dev Mar 22, 2026
1 check passed
@e6qu e6qu deleted the docs/readme-overhaul branch March 22, 2026 18:11
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