Skip to content

docs: add FAQ.md answering common setup and contribution questions (#462)#474

Merged
Sulex45 merged 1 commit into
stellarkit-lab-devtools:mainfrom
ironhood:docs/faq-462
Jul 7, 2026
Merged

docs: add FAQ.md answering common setup and contribution questions (#462)#474
Sulex45 merged 1 commit into
stellarkit-lab-devtools:mainfrom
ironhood:docs/faq-462

Conversation

@ironhood

@ironhood ironhood commented Jul 4, 2026

Copy link
Copy Markdown

Description

Closes #462

This PR introduces a new FAQ.md file at the repository root to address the most common setup, contribution, and architectural questions that new developers have when evaluating StellarKit API.

The questions and answers were synthesized from our existing documentation (api-design.md, CONTRIBUTING.md, and README.md) to ensure all technical explanations and conventions remain consistent across the repository.

Changes Made

  • Added FAQ.md at the repository root containing 8 detailed questions and answers:
    1. Why is the API needed when Horizon already exists?
    2. Can it be used on mainnet?
    3. Is an API key required?
    4. Why are some endpoints cached and others not?
    5. How are Stellar Wave points awarded?
    6. What is the standard response envelope?
    7. How are Stellar amounts and fees formatted?
    8. How does pagination work?
  • Updated README.md: Added a link to FAQ.md under the existing Documentation section for easy discovery.

Acceptance Criteria Reached

  • FAQ.md exists at the repo root.
  • Contains at least eight questions and answers.
  • Answers are written in plain, direct language and are consistent with existing docs.
  • Linked from the README.md under the "Documentation" section.

@drips-wave

drips-wave Bot commented Jul 4, 2026

Copy link
Copy Markdown

@ironhood Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@ironhood

ironhood commented Jul 4, 2026

Copy link
Copy Markdown
Author

Hi Maintainer, kindly review my PR

1 similar comment
@ironhood

ironhood commented Jul 4, 2026

Copy link
Copy Markdown
Author

Hi Maintainer, kindly review my PR

@Sulex45 Sulex45 merged commit 024388b into stellarkit-lab-devtools:main Jul 7, 2026
1 of 3 checks passed
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.

Add a FAQ.md answering common setup and contribution questions

2 participants