Skip to content

docs(ENG-238): Add algorithm registry and CPI linking#54

Merged
alnoki merged 10 commits intomainfrom
eng-238
Apr 3, 2026
Merged

docs(ENG-238): Add algorithm registry and CPI linking#54
alnoki merged 10 commits intomainfrom
eng-238

Conversation

@alnoki
Copy link
Copy Markdown
Contributor

@alnoki alnoki commented Apr 3, 2026

Changes

  1. Add algorithms/registry.json as a central declarative
    mapping between algorithm specs (.tex) and their assembly
    implementations (.s), replacing the scattered tex/asm
    prop pairs in markdown files and absorbing syscalls.json
  2. Add cpis section to the registry for cross-program
    invocation targets with links to upstream source definitions
  3. Simplify <Algorithm> component to a single id prop that
    resolves both the .tex source and assembly file from the
    registry
  4. Extend .tex syntax to annotate CPI targets on syscalls
    (e.g. \CALL{sol-invoke-signed-c}{system-program::CreateAccount}),
    rendered as linked sol_invoke_signed_c(system_program::CreateAccount)
  5. Add root prop to <AlgorithmIndex> for scoped dependency
    graphs showing only a single algorithm and its transitive deps
  6. Switch dependency chart to LR layout with color-coded nodes
    (green algorithms, grey syscalls, blue CPIs)
  7. Add build-time validation that every .tex file has a
    registry entry and vice versa
  8. Fix prelude comment indentation in pseudocode rendering
  9. Update docs-engine.md and CLAUDE.md documentation

@linear
Copy link
Copy Markdown

linear bot commented Apr 3, 2026

ENG-238

@alnoki alnoki changed the title ENG-238 docs(ENG-238): Add algorithm registry and CPI linking Apr 3, 2026
@alnoki alnoki marked this pull request as ready for review April 3, 2026 23:45
@alnoki alnoki merged commit 9ab0c2e into main Apr 3, 2026
5 of 6 checks passed
@alnoki alnoki deleted the eng-238 branch April 3, 2026 23:46
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