Skip to content

Doc generator for Soroban contracts (cargo doc --document-private-items published to docs.rs) #162

Description

@snowrugar-beep
  • Problem Statement. No published API doc; readers need to
    read each lib.rs.
  • Why it matters. Open-source maintainability.
  • Expected Outcome. contracts/<name>/Cargo.toml ships the
    metadata needed for docs.rs; CI verifies cargo doc builds.
  • Acceptance Criteria.
    1. CI verifies docs build clean (no broken links).
  • Files / Modules. contracts/*/Cargo.toml,
    .github/workflows/contracts-docs.yml.
  • Difficulty. Easy.
  • Effort. 1 day.
  • Labels. ci, contracts, docs.

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26ciImported from docs/ISSUES_100.md (label "ci").contractsImported from docs/ISSUES_100.md (label "contracts").docsImported from docs/ISSUES_100.md (label "docs").

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions