Summary
Add comprehensive documentation for OpenWebSheet so contributors and users can understand, run, develop, extend, and maintain the project more easily.
Scope
- Improve the README with clearer project overview, features, screenshots, and setup instructions.
- Add developer documentation for local development, build/test commands, architecture, and contribution workflow.
- Document the separation between UI, spreadsheet core, rendering, formula handling, and import/export modules.
- Add user-facing documentation for loading/saving files, editing sheets, formulas, formatting, and PWA installation.
- Document supported file formats and known limitations.
- Add troubleshooting notes for common setup/runtime issues.
Suggested acceptance criteria
- README is updated and useful for first-time users and contributors.
- A
docs/ directory or equivalent documentation structure exists.
- Architecture boundaries are documented, especially UI vs core responsibilities.
- Development, testing, and release/build instructions are complete.
- Documentation is kept close enough to the codebase to be maintainable.
Notes
This issue can be split into smaller documentation tasks if needed.
Summary
Add comprehensive documentation for OpenWebSheet so contributors and users can understand, run, develop, extend, and maintain the project more easily.
Scope
Suggested acceptance criteria
docs/directory or equivalent documentation structure exists.Notes
This issue can be split into smaller documentation tasks if needed.