Skip to main content

Contributing

If you are editing these docs, keep the changes simple and reviewable.

Before you submit

  • read the overview pages first
  • keep tool names aligned with the MCP package
  • avoid old project-specific wording
  • do not add emoji
  • use short, direct sentences

Good contribution targets

  • clearer installation flow
  • better architecture diagrams
  • more accurate tool reference copy
  • improved testing notes
  • tighter explanations of why PIXA uses Algorand as the home wallet

Suggested workflow

  1. make the content change
  2. preview locally with Mintlify
  3. check broken links
  4. verify the examples still match the code
  5. commit with a small, focused diff

What to avoid

  • copying the old project language back in
  • making the overview too technical too early
  • describing roadmap items as if they are already shipped
  • adding large sections that do not help a new reader understand the product

Style rule

Write for a human who is trying to understand PIXA in one pass. If a paragraph can be shorter, make it shorter.