-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Background
The project's documentation has two key issues that need to be addressed:
- README.md contains minor inaccuracies and inconsistencies
- CONTRIBUTING.md is currently in French and focused on maintainers rather than external contributors
Tasks for README.md
- Correct the UMD path reference (currently inconsistent with actual output)
- Update usage example that incorrectly uses
new VisualImageTool.VisualImageTool() - Update the Vue example (currently using Vue 2 syntax)
- Ensure the demo list is consistent with the actual demo directory contents
- Fix script name inconsistency (
format:writevsformat:fix) - Add a note about default focus point behavior for clarity
Tasks for CONTRIBUTING.md
- Translate the entire document from French to English
- Refocus the content to guide external contributors rather than just maintainers
- Include guidelines for:
- Submitting issues
- Creating pull requests
- Following code style and coding standards
- Running tests (once implemented)
- Development workflow
- Consider creating a separate MAINTAINER_GUIDE.md for maintainer-specific information
Expected Outcome
- Accurate and consistent README.md that properly guides users
- English CONTRIBUTING.md that encourages and guides external contributions
- Clear separation of maintainer vs contributor documentation
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation