Skip to content

fix(docs): remove Ergo references and modernise documentation#505

Merged
mttrbrts merged 12 commits into
mainfrom
mr-remove-ergo
Apr 26, 2026
Merged

fix(docs): remove Ergo references and modernise documentation#505
mttrbrts merged 12 commits into
mainfrom
mr-remove-ergo

Conversation

@mttrbrts

@mttrbrts mttrbrts commented Mar 1, 2026

Copy link
Copy Markdown
Member

Summary

Removes all remaining references to Ergo across the Accord Project documentation, replacing them with TypeScript and Concerto equivalents. Also modernises the homepage, footer, and example content to reflect the current state of the project.

Changes

Documentation

  • Removed broken anchor link definitions and stale CLA/Travis references from CONTRIBUTING.md
  • Audited and updated all ergo code fence labels across 8 docs files to concerto or typescript as appropriate
  • Renamed "Ergo Formulas" section to "Template Formulas" in markup-ciceromark.md
  • Updated tutorial-studio.md to reference the "Logic tab" and "template engine" rather than Ergo
  • Replaced the "Eat Apples" clause example with a realistic late payment clause in example-eatapple.md

Images

  • Patched all 4 template triangle thumbnails (template.png, template_logic.png, template_text.png, template_model.png) to replace the "ERGO" label with "TypeScript"

Website

  • Updated homepage hero text and Features section — added logo images for TypeScript and Concerto
  • Disabled stale "Who's Using This?" showcase section pending refresh
  • Removed outdated footer links (Stack Overflow, Twitter/X, Medium blog)
  • Moved homepage images from /docs/assets/020/ to /img/ and added updated assets (grammar, studio, template playground screenshot)
  • Removed blockchain reference from homepage copy
  • Updated GitHub star button to point to template-archive repo

Housekeeping

  • Added AGENTS.md with beads/bd agent workflow instructions
  • Added .dolt/ and *.db to .gitignore

Flags

  • The legacy Ergo screenshots in docs/assets/advanced/ (tutorial-studio walkthrough images) are left as-is; tutorial-studio.md now carries an admonition noting it describes a legacy Ergo workflow.
  • docs/ref-migrate-concerto-3.0-4.0.md is included as a stub — content to be expanded in a follow-up.

Author Checklist

  • DCO sign-off provided on all commits (--signoff)
  • Commits follow AP format (type(scope): description)
  • Merging to main from mr-remove-ergo
  • Documentation extended where necessary

@mttrbrts mttrbrts mentioned this pull request Mar 1, 2026
5 tasks
ChinmayaBiswal7 and others added 2 commits March 6, 2026 21:10
…507)

- Fix homepage heroCover hero section styling in custom.css (v3 compatibility)
- Remove Ergo as primary feature; replace with TypeScript/Template Logic card
- Update Logic ContentBlock: Ergo description -> TypeScript, ergo.png -> template_logic.png
- Fix broken /docs/model-concerto internal links -> concerto.accordproject.org/docs/intro
- Fix broken image paths in started-hello.md (3x) and tutorial-library.md (1x)
  - /docs/assets/basic/* -> ./assets/basic/* (Docusaurus v3 relative paths)
- Fix empty link [fixed rate loan]() -> https://playground.accordproject.org
- Update tutorial-templates.md: logic.ergo -> logic.ts, Ergo code -> TypeScript
- Update tutorial-library.md: directory structure logic.ergo -> logic.ts
- Update tutorial-create.md: generator output, test runner (cucumber->vitest),
  and Edit Logic section now documents TypeScript pattern

References: accordproject/cicero-template-library#484

Signed-off-by: ChinmayaBiswal7 <chinmayabiswal44@gmail.com>
Signed-off-by: ChinmayaBiswal7 <chinmayabiswal777@gmail.com>
Signed-off-by: nonononoonononon <yuangli971@gmail.com>
mttrbrts and others added 8 commits April 12, 2026 21:48
Signed-off-by: Matt Roberts <7544022+mttrbrts@users.noreply.github.com>
…erences

- Remove TOC entries for non-existent sections (Updating Documentation, Technical Documentation)
- Remove broken contribute.cla, contribute.updating, contribute.techdocs link defs
- Remove broken developers.pullrequest link def (DEVELOPERS.md has no #pullrequest anchor)
- Update PR submission paragraph to remove stale CLA/Travis references; mention DCO

Closes #515

Signed-off-by: Matt Roberts <code@rbrts.uk>
- Change code fence labels from `ergo` to `concerto` in all files where
  the block contains Concerto model syntax (not Ergo language):
  markup-templatemark.md (12 blocks), accordproject-template.md,
  accordproject-slc.md, tutorial-templates.md, tutorial-studio.md (2 blocks),
  ref-errors.md, example-eatapple.md
- Convert the Ergo logic example in example-eatapple.md to TypeScript
  using the TemplateLogic class pattern
- Rename 'Ergo Formulas' section in markup-ciceromark.md to
  'Template Formulas' and update the description
- Update tutorial-studio.md prose: remove 'in Ergo', update 'Ergo tab'
  to 'Logic tab', update 'Ergo engine' to 'template engine'; add note
  that the tutorial covers legacy Ergo-based templates
- Intentional Ergo reference files (ref-ergo-*, logic-*.md,
  ergo-tutorial.md, ref-migrate-*.md) are left unchanged

Signed-off-by: Matt Roberts <code@rbrts.uk>
Updated template.png and template_logic.png in-place using Pillow:
- Painted over the 'ERGO' subtitle at the LOGIC vertex
- Drew 'TypeScript' in the same position using Arial Bold at
  matching size and navy colour (#5 0C 40)

Closes techdocs-4tw

Signed-off-by: Matt Roberts <code@rbrts.uk>
…late_model thumbnails

Same Pillow patch applied to the remaining two thumbnail images
(template_text.png, template_model.png) which share the same mini
triangle layout as template_logic.png.

Signed-off-by: Matt Roberts <code@rbrts.uk>
Added beads/bd agent instructions as AGENTS.md.
Updated .gitignore to exclude .dolt/ and *.db files
created by bd init.

Signed-off-by: Matt Roberts <code@rbrts.uk>
Rewrote example-eatapple.md to use a more representative
late payment clause example with TypeScript logic.
Also added ref-migrate-concerto-3.0-4.0.md migration guide.

Signed-off-by: Matt Roberts <code@rbrts.uk>
- Updated homepage hero text and Features section with logo images
  for TypeScript and Concerto
- Disabled stale 'Who's Using This?' showcase section
- Removed outdated footer links (Stack Overflow, Twitter, Medium blog)
- Updated image paths from /docs/assets/020/ to /img/
- Added template.png, template_logic.png, template-playground.png,
  concerto-logo.svg, typescript-logo.svg to website/static/img/
- Updated grammar.png and studio.png
- Replaced blockchain reference in homepage copy
- Updated GitHub star button to point to template-archive repo

Signed-off-by: Matt Roberts <code@rbrts.uk>
@mttrbrts mttrbrts marked this pull request as ready for review April 25, 2026 22:00
@mttrbrts mttrbrts changed the title Upgrade to Docusaurus and Migrate to vNext fix(docs): remove Ergo references and modernise documentation Apr 25, 2026
@mttrbrts mttrbrts merged commit a4c6a64 into main Apr 26, 2026
5 of 6 checks passed
@mttrbrts mttrbrts deleted the mr-remove-ergo branch April 26, 2026 19:30
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.

3 participants