Skip to content

chore: migrate ace related api docs to new cm one#55

Open
bajrangCoder wants to merge 2 commits intomainfrom
cm
Open

chore: migrate ace related api docs to new cm one#55
bajrangCoder wants to merge 2 commits intomainfrom
cm

Conversation

@bajrangCoder
Copy link
Member

No description provided.

@bajrangCoder bajrangCoder changed the title chore: migrate ace realted api docs to new cm one chore: migrate ace related api docs to new cm one Feb 19, 2026
@greptile-apps
Copy link

greptile-apps bot commented Feb 19, 2026

Greptile Summary

Comprehensive migration of documentation from Ace editor APIs to CodeMirror 6, updating all plugin development guides and API references to reflect the new editor architecture.

Key Changes

  • New API Documentation: Added complete docs for commands, editorLanguages, editorThemes, lsp, and fileHandlers APIs
  • Migration Guides: Converted ace.md into a migration guide with compatibility layer documentation and quick reference map
  • Updated Examples: All code examples now use CodeMirror-first patterns (e.g., acode.require("commands") instead of editorManager.editor.commands)
  • Type Updates: Changed type definitions to reflect CodeMirror types (EditorView, Proxy<EditorState>, etc.)
  • New Plugin Lifecycle Docs: Completely rewrote understanding-plugin.md with comprehensive init/unmount contract documentation
  • Settings Documentation: Updated editor settings to reflect CodeMirror options, removed obsolete Ace-era settings

Documentation Quality

  • Clear migration paths with side-by-side comparisons
  • Comprehensive examples including full plugin implementations
  • Backward compatibility documented where it exists
  • Cross-references added between related APIs

Confidence Score: 5/5

  • This PR is safe to merge - it's a documentation-only update with no code changes to the application itself
  • All changes are documentation updates migrating from Ace to CodeMirror APIs. The changes are well-structured, comprehensive, and maintain backward compatibility information. No runtime code is modified.
  • No files require special attention - all documentation changes are clear and well-organized

Important Files Changed

Filename Overview
docs/global-apis/ace.md Repurposed as migration guide from Ace to CodeMirror with compatibility layer documentation and quick migration map
docs/global-apis/acode.md Updated examples to use acode.require("commands") instead of editorManager.editor.commands, added new APIs (format, formatters, getFormatterFor, waitForPlugin, clearBrokenPluginMark)
docs/global-apis/editor-manager.md Completely rewritten to document editorManager.editor as CodeMirror EditorView with examples and Ace compatibility layer helpers
docs/utilities/ace-modes.md Renamed to Editor Languages (CodeMirror), documented new editorLanguages API with register/unregister methods, kept aceModes alias for backward compatibility
docs/utilities/editor-themes.md New file documenting comprehensive CodeMirror theme API with registration, helpers, and complete plugin examples
docs/utilities/commands.md New file documenting Commands API as preferred method for command registration/removal over editorManager.editor.commands
docs/advanced-apis/lsp.md New comprehensive LSP API documentation with WebSocket transport details, AXS bridge setup examples, and server registration patterns
docs/getting-started/understanding-plugin.md Completely rewritten with comprehensive plugin lifecycle documentation including init/unmount contract, runtime context, and failure behavior
user-guide/settings/editor-settings.md Completely rewritten to document CodeMirror-based settings, removed Ace-era options, added new options (Rainbow Brackets, Indent Guides, Lint Gutter)

Last reviewed commit: cc9d194

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.

1 participant

Comments