docs: add FAQ.md answering common setup and contribution questions (#462)#474
Merged
Merged
Conversation
|
@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! 🚀 |
Author
|
Hi Maintainer, kindly review my PR |
1 similar comment
Author
|
Hi Maintainer, kindly review my PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #462
This PR introduces a new
FAQ.mdfile 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, andREADME.md) to ensure all technical explanations and conventions remain consistent across the repository.Changes Made
FAQ.mdat the repository root containing 8 detailed questions and answers:README.md: Added a link toFAQ.mdunder the existing Documentation section for easy discovery.Acceptance Criteria Reached
FAQ.mdexists at the repo root.README.mdunder the "Documentation" section.