Skip to content

docs: add FAQ and link it from README - #260

Open
Osaodion wants to merge 1 commit into
DepRadarOrg:mainfrom
Osaodion:security/issue-160-add-a-faq
Open

Osaodion wants to merge 1 commit into
DepRadarOrg:mainfrom
Osaodion:security/issue-160-add-a-faq

Conversation

@Osaodion

Copy link
Copy Markdown

Overview

This PR adds docs/FAQ.md answering common contributor and user questions (whether this is mainnet, who decides bounty claims, what counts as a finding), and links it from the README. A PROGRESS.md entry records the change.

Related Issue

Closes #

Changes

📄 Documentation

  • [ADD] docs/FAQ.md

    • Covers at least 10 questions drawn from the README, contract docs, and SECURITY.md.
  • [MODIFY] PROGRESS.md

    • Adds an entry for the FAQ work.

Verification Results

Manual review of docs/FAQ.md:
- Commands and links checked against the repository
Acceptance Criteria Status
All commands and links in the new docs have been verified ✅ Checked manually against the repo
PROGRESS.md entry added ✅ Added
PR description includes Closes #<this issue> ✅ Included

Closes #160

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.

[docs] Add a FAQ

1 participant