Claude/docs cleanup help 9 cxt v #307
Merged
Conversation
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
- Remove duplicate docs: features/3d-viewer.md, features/csv-import.md - Remove incomplete guides/flexible_metadata_guide.md - Update sidebar to remove references to deleted files - Add Documentation link to Help page quick links - Change Help page grid to 4-column layout
- Add CONTRIBUTING.md with contribution guidelines - Add SECURITY.md with vulnerability reporting process - Add CODE_OF_CONDUCT.md (Contributor Covenant based) - Enhance README with manufacturing context and use cases - Remove duplicate SELF_HOSTING_GUIDE.md from website docs
- Fix links in CSV_IMPORT.md to use correct absolute paths - Fix links in erp-integration.md to correct API/guide paths - Fix links in shipping-management.md to correct cross-references - Fix links in MCP_INTEGRATION.md (HOW-THE-APP-WORKS -> app-architecture) - Fix links in error-handling.md (case sensitivity and correct paths) - Fix links in quick-start.md (incorrect architecture link, broken README link)
- Reduce Help.tsx from 1,203 to 267 lines (78% reduction) - Remove all hardcoded content (operators, admins, FAQ, ERP tabs) - Keep only: quick links, doc links to website, releases - Point users to eryxon.com/docs for full documentation - No localization needed - minimal hardcoded strings
Sidebar restructure: - Add "User Guides" section (operator-manual, admin-manual, 3d-viewer, csv-import, faq, troubleshooting) - Add "Self-Hosting" section (deployment guide, quality management) - Add "Development" section (developer guide, coding patterns) - Reorder Features section logically - All 9 previously hidden docs now accessible File naming: - Rename uppercase files to lowercase for consistency - API_DOCUMENTATION.md → api_documentation.md - CSV_IMPORT.md → csv_import.md - CLAUDE.md → claude.md - CODING_PATTERNS.md → coding_patterns.md
Alpha 0.1 focus is on: - Browser-side Three.js rendering - APIs and sync endpoints - Demo account and basic workflow PMI Extraction and custom 3D Engine are WIP - moved to separate "Roadmap (WIP)" section to set clear expectations.
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.
No description provided.