Skip to content

feat: update docs - #109

Merged
bajrangCoder merged 2 commits into
Acode-Foundation:mainfrom
RohitKushvaha01:docs/plugin-api-docs
Sep 22, 2026
Merged

bajrangCoder merged 2 commits into
Acode-Foundation:mainfrom
RohitKushvaha01:docs/plugin-api-docs

Conversation

@RohitKushvaha01

@RohitKushvaha01 RohitKushvaha01 commented Sep 22, 2026 •

Copy link
Copy Markdown
Member

Recreated from #102 (original fork was deleted). Recovered via refs/pull/102/head

@greptile-apps

greptile-apps Bot commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

The PR appears safe to merge, with a non-blocking documentation inconsistency around the recommended API for long-running commands.

Findings

  1. P2 Hidden Long-Running Execution ▶

Summary

This PR expands the plugin API documentation with native plugin context, executor, and Android system API references; updates lifecycle examples to match the official class-based templates; and adds the new pages to VitePress navigation.

  • Documents encrypted plugin-scoped secrets and the current limitations of permission declarations.
  • Adds detailed shell execution and native Android bridge references.
  • Updates initialization and cleanup examples across onboarding and core API pages.
  • Correctly updates the acode API summary to describe ctx as nullable.
  • The newly added executor-selection note conflicts with existing guidance for long-running work.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  Plugin[Plugin entry file] --> Init[setPluginInit]
  Init --> Context[PluginContext]
  Context --> Secrets[Encrypted secrets]
  Context --> Permissions[Declared permission metadata]
  Plugin --> Terminal[Visible terminal session]
  Plugin --> Executor[Non-interactive command execution]
  Plugin --> System[Native Android system bridge]
  Plugin --> Cleanup[setPluginUnmount / destroy]
Loading

Reviews (3) · Last reviewed commit: "Update docs/global-apis/acode.md"

Comment thread docs/global-apis/config.md Outdated
@greptile-apps

This comment has been minimized.

Comment thread docs/advanced-apis/executor.md
@RohitKushvaha01

This comment was marked as resolved.

Comment thread docs/global-apis/acode.md Outdated
- add Advanced APIs pages for Executor and System
- document when to use the foreground vs background executor (short- vs
  long-running commands)
- add Plugin Context (ctx) page covering encrypted secrets and permission
  checks, warning that plugin.json permissions are not enforced by Acode yet
- document the ctx and fileIcons init options in core-file,
  understanding-plugin and acode
- fold the terminal page's Executor.execute section into the new Executor page
- drop the unused permissions entry from the manifest example
- add sidebar entries for the new pages
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@RohitKushvaha01

This comment was marked as resolved.

Comment thread docs/advanced-apis/executor.md
@bajrangCoder
bajrangCoder merged commit 133c60b into Acode-Foundation:main Sep 22, 2026
2 checks passed
@RohitKushvaha01
RohitKushvaha01 deleted the docs/plugin-api-docs branch September 22, 2026 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants