Skip to content

Fill gaps in the Stellar contributor development guide #199

Description

@Hey-Yetunde

Problem

Much of the original guide now exists: docs/stellar.md documents implemented pieces, docs/soroban.md documents the RPC client and its security model, docs/architecture.md explains layering, and CONTRIBUTING.md gained a Stellar section (where code lives, rules, testnet/custom setup, test commands). Two things the original issue called out are still thin: a concrete local node setup walkthrough and how to extend detection/analysis end to end.

Context

  • docs/stellar.md, docs/soroban.md, docs/architecture.md, and CONTRIBUTING.md (Stellar section).
  • The Stellar service, detection, analysis, CLI, and /stellar web tools.

Much of the underlying guide has now landed; this issue tracks the remaining gaps.

Scope

Fill the two remaining gaps without duplicating the existing docs.

Requirements

  • Add a step-by-step local development node section: how to run a local stellar-rpc/stellar-core (or a documented mock), the exact STELLAR_NETWORK=custom + loopback URL settings, and how to verify with flask stellar health.
  • Add a "extend a Stellar feature" walkthrough: e.g. adding a new read-only inspection method or a new detection signal, from service method → test → CLI/API exposure → doc update, including the SSRF/read-only rules recap.
  • Link to the existing docs rather than duplicating them; keep the guide's claims matching the code.

Acceptance Criteria

  • A contributor can follow the local-node section and the extension walkthrough end to end.
  • Links resolve; the guide stays consistent with the implemented code.

Testing

  • Doc review + link checks; existing tests must stay green.

Dependencies

Out of Scope

  • Rewriting existing documentation wholesale.

Expected Outcome

A contributor can set up a local node and safely extend a Stellar feature following one guide.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    difficulty/mediumdocumentationImprovements or additions to documentationphase-8Work scoped for Phase 8: Plugins & Extensionspriority/mediumstellarStellar network integration and tooling

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions