Skip to content

Enhance README with detailed features and structure - #2911

Closed
marcelstevano15 wants to merge 2 commits into
Acode-Foundation:mainfrom
marcelstevano15:patch-1
Closed

marcelstevano15 wants to merge 2 commits into
Acode-Foundation:mainfrom
marcelstevano15:patch-1

Conversation

@marcelstevano15

Copy link
Copy Markdown

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.

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.
@greptile-apps

greptile-apps Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 4/5

This documentation-only PR appears safe to merge, with non-blocking factual corrections recommended to avoid misleading users and contributors.

Findings

  1. P2 Incorrect editor engine
  2. P2 Unsupported GitHub integration claim
  3. P2 Settings do not cloud-sync
  4. P2 Incorrect shell startup filename
  5. P2 Paid build purchase confusion

Summary

Expands the README with grouped feature descriptions, architecture and edition information, build variants, nightly APK downloads, project structure, translation checks, and community links.

  • Most feature and workflow descriptions match the implementation.
  • Correct the editor engine, GitHub integration claim, settings-sync claim, terminal startup filename, and paid-build explanation.
  • Changes are documentation-only; no application behavior is modified.

Reviews (1) · Last reviewed commit: "Enhance README with detailed features an..."

Comment thread readme.md Outdated
- 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Incorrect editor engine

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!

Comment thread readme.md Outdated
- 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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.

Suggested change
- GitHub integration for syncing projects, including previewing files by GitHub URI

Comment thread readme.md Outdated

**Connectivity & sync**
- GitHub integration for syncing projects, including previewing files by GitHub URI
- Acode account/cloud sync for purchases and settings across devices

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Settings do not cloud-sync

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.

Suggested change
- 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

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 (/initrc instead 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the recheck! @bajrangCoder @UnschooledGamer this should be ready for a maintainer review whenever you have a chance.

Comment thread readme.md Outdated
Comment thread readme.md Outdated
fix: correct editor engine, GitHub sync claim, terminal filename, and build variant docs
@RohitKushvaha01

Copy link
Copy Markdown
Member

Hello, thank you for your efforts but we do not want to change Readme for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants