Skip to content

Documentation style guide #640

Closed
Closed
Documentation style guide#640
Assignees
josephchimebuka
Labels
Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationdx

Description

@codebestia
codebestia
opened on Oct 19, 2026

Branch: Open your PR against dev. PRs targeting main are closed automatically.

Description:
Write docs/documentation-style-guide.md, codifying the conventions the documentation batches have followed so far, so that new docs stay consistent.

Acceptance criteria:

  • Documents file placement and naming: per-app docs/ folders, flat files, the api- / contracts- / concepts- / howto- / tutorial- prefixes and what each means
  • States the core rule: write against the current code, not IMPLEMENTATION_DOCS.md, and state limitations honestly instead of describing intended behaviour
  • Covers diagrams (Mermaid), code references (repo-relative paths), cross-linking instead of duplicating, and how to mark a doc that will go stale when a known change lands
  • Includes a short checklist for reviewing a docs PR

Activity

  1. codebestia
    added
    documentationImprovements or additions to documentation
    dx
    on Oct 19, 2026
  2. drips-wave
    added
    Stellar WaveIssues in the Stellar wave program
    on Oct 19, 2026

  3. Vivian-04 commented on Oct 20, 2026

    @Vivian-04
    Vivian-04
    on Oct 20, 2026 – with Drips Wave

    @Vivian-04 has applied to work on this issue as part of the Stellar Wave Program's 10th wave.

    Hiiiiiiii there!

    I would absolutely love to work on this for youuu quickly and properly!
    Kindly assign to me so i can start immediately!

    ETA; 1-2hours

    Thank youu!

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @Vivian-04 to this issue.

  4. josephchimebuka commented on Oct 20, 2026

    @josephchimebuka
    josephchimebuka
    on Oct 20, 2026 – with Drips Wave
    Contributor

    @josephchimebuka has applied to work on this issue as part of the Stellar Wave Program's 10th wave.

    Hi GM, I have reviewed this issue and taken the time to understand the requirements, current implementation, and the expected outcome. Based on my analysis, I believe this is something I can successfully handle and contribute to... Kindly assign

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @josephchimebuka to this issue.

  5. codebestia
    assigned
    josephchimebuka
    on Oct 20, 2026

  6. drips-wave commented on Oct 20, 2026

    @drips-wave
    drips-waveBot
    on Oct 20, 2026 – with Drips Wave

    Congratulations, @josephchimebuka! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on October 22, 2026.

    🧑‍💻 @josephchimebuka: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

    Warning

    When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

    🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

    🌊 Happy Wave 🌊

  7. codebestia
    added 2 commits that reference this issue on Oct 22, 2026

    docs: add landing, style guide, identity trust, and MLS client docs (#…

    2589532

    Merge pull request #683 from josephchimebuka/docs/630-640-626-627

    b3f27b5

  8. github-actions commented on Oct 22, 2026

    @github-actions
    github-actionsBot
    on Oct 22, 2026 – with GitHub Actions

    Closed by #683, merged into dev.

  9. github-actions
    closed this as completedon Oct 22, 2026

  10. drips-wave commented on Oct 22, 2026

    @drips-wave
    drips-waveBot
    on Oct 22, 2026 – with Drips Wave

    This issue has been completed by @josephchimebuka as part of the Stellar Wave Program's 10th Wave 🥳

    😎 @josephchimebuka: You earned 200 Points for completing this issue! Once the Wave's rewards are finalized, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

    🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.

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

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationdx

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions