Skip to content

docs: Audit and remove legacy Ergo references in favor of TypeScript (Cicero 0.25+) #513

@ChinmayaBiswal7

Description

@ChinmayaBiswal7

Issue Background
The Accord Project recently migrated its template engine to Cicero 0.25+ (as seen in cicero-template-library PR #484), officially deprecating the legacy Ergo domain-specific language in favor of standard TypeScript.

While the homepage and core deep-dive tutorials were successfully updated in PR #507 to reflect this TypeScript shift, a codebase audit reveals that over 800+ legacy references to Ergo still exist scattered throughout the secondary documentation.

The Problem / Impact on Users
Leaving these legacy references completely breaks the learning experience for new developers joining the Accord Project ecosystem. Specifically:

Confusion for Newcomers: Files like started-resources.md and the CLI reference guides still instruct users to write logic.ergo files and use the outdated ergoc compiler.
Broken Tooling Assumptions: The documentation heavily promotes outdated editor plugins (Ergo Emacs Mode, Ergo VIM Plugin) which are no longer relevant to the modern TypeScript workflow.
Inconsistent Syntax: Many code blocks across the documentation are still tagged with "ergo" syntax highlighting, which will confuse developers trying to write valid TypeScript or Concerto models.
Proposed Solution (Step-by-Step)
In accordance with the project's goal to standardize on TypeScript, I propose a sweeping audit and cleanup to resolve these inconsistencies. My plan of action is:

Conduct a global search-and-replace audit on all markdown files in the docs folder to find remaining mentions of "ergo", "logic.ergo", and "ergoc".
Standardize File References: Replace all instructional text pointing to logic.ergo with logic.ts, ensuring directory structure examples are accurate for Cicero 0.25+.
Fix Syntax Blocks: Manually review code blocks currently tagged as "ergo". If the block contains contract logic, change it to "typescript". If the block contains model definitions, change it to "concerto".
Deprecate Legacy Tools: Update the started-resources.md file to remove or explicitly mark the Ergo VIM/Emacs plugins as deprecated, pointing users toward standard TypeScript tooling (like VS Code TS extensions) instead.
Update Migration Guides: Review the older migration guides (like ref-migrate-0.13-0.20) to ensure warnings are present regarding Ergo's complete deprecation in the newest versions.
I have just completed the homepage and core tutorial updates in PR #507 and familiarized myself with the Docusaurus v3 structure. I would like to take ownership of this issue and open a PR with these cleanups.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions