Enhance README with detailed features and structure - #2911
marcelstevano15 wants to merge 2 commits into
Conversation
Expanded the overview section to include details about the underlying technology and editions. Added new features related to the editor core, preview & debugging, terminal & servers, connectivity & sync, extensibility, and build variants. Updated project structure and multi-language support sections.
|
| - Enjoy multi-language editing support with easy management tools. | ||
| - Enjoy a large collections of community plugins to enhance your coding experience. | ||
| **Editor core** | ||
| - Ace-based editor with syntax highlighting for 100+ programming and markup languages |
There was a problem hiding this comment.
The editor uses CodeMirror 6, not Ace. editorManager.js imports CodeMirror’s EditorState and EditorView, and the Ace-facing API is a compatibility layer. Calling it “Ace-based” here and “the Ace editor engine” in the overview gives contributors incorrect architectural guidance. Update both references to CodeMirror.
Knowledge Base Used: Workspace and code editor
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| - S/FTP and SSH terminal integration, including ED25519 key support, with resilient connection handling for stalled connections | ||
|
|
||
| **Connectivity & sync** | ||
| - GitHub integration for syncing projects, including previewing files by GitHub URI |
There was a problem hiding this comment.
Unsupported GitHub integration claim
This advertises built-in GitHub project synchronization and GitHub-URI previews, but the shipped filesystem providers and file-opening flow implement neither. GitHub references support updates, downloads, account metadata, and links rather than repository synchronization. Remove this bullet, or identify the optional plugin or terminal workflow required, so readers are not directed toward a nonexistent built-in feature.
| - GitHub integration for syncing projects, including previewing files by GitHub URI |
|
|
||
| **Connectivity & sync** | ||
| - GitHub integration for syncing projects, including previewing files by GitHub URI | ||
| - Acode account/cloud sync for purchases and settings across devices |
There was a problem hiding this comment.
Account login restores purchase entitlement, but it does not synchronize settings across devices. settings.js saves preferences to the device’s settings.json, and transferring them uses manual backup and restore. Restrict this claim to purchases and describe settings transfer separately; otherwise users may expect their preferences to appear on another device after signing in.
| - Acode account/cloud sync for purchases and settings across devices | |
| - Acode account for restoring purchase entitlement across devices | |
| - Manual settings backup and restore |
Knowledge Base Used: Settings, themes, and localization
There was a problem hiding this comment.
Thanks for the review, @greptile-apps! I've pushed a fix commit addressing all 5 findings:
- Corrected the editor engine reference (CodeMirror 6, not Ace)
- Removed the unsupported GitHub sync/preview claim
- Fixed the settings-sync claim to accurately describe purchase-restore vs. manual settings backup
- Corrected the shell startup filename (
/initrcinstead of.initrc) - Clarified the free/paid build variant vs. in-app purchase distinction
All changes are documentation-only, no application behavior touched. Ready for another look whenever convenient.
There was a problem hiding this comment.
Thanks for the follow-up. I rechecked the updated readme.md against the repository contents, and all five previously reported documentation issues are addressed:
- CodeMirror 6 and the Ace-compatible plugin API layer are now described accurately.
- The unsupported GitHub sync/preview claim is removed.
- Purchase restoration is separated from manual settings backup and restore.
- The terminal documentation now uses
/initrc, matching the runtime scripts. - The free/paid artifact distinction is separated from the in-app purchase path.
The build command and project-structure descriptions also match the repository scripts and documentation. No further findings.
Tip: You can customize Greptile's behavior for this repo with .greptile/rules.md and .greptile/config.json.
There was a problem hiding this comment.
Thanks for the recheck! @bajrangCoder @UnschooledGamer this should be ready for a maintainer review whenever you have a chance.
fix: correct editor engine, GitHub sync claim, terminal filename, and build variant docs
|
Hello, thank you for your efforts but we do not want to change Readme for now |
Expanded the overview section to include details about the underlying technology and editions. Added new features related to the editor core, preview & debugging, terminal & servers, connectivity & sync, extensibility, and build variants. Updated project structure and multi-language support sections.