Skip to content

chore(docs): add development docs#408

Merged
rvagg merged 2 commits intomasterfrom
rvagg/development.md
Apr 9, 2026
Merged

chore(docs): add development docs#408
rvagg merged 2 commits intomasterfrom
rvagg/development.md

Conversation

@rvagg
Copy link
Copy Markdown
Member

@rvagg rvagg commented Apr 8, 2026

Closes: #300

Copilot AI review requested due to automatic review settings April 8, 2026 16:47
@FilOzzy FilOzzy added team/filecoin-pin "Filecoin Pin" project is a stakeholder for this work. team/fs-wg FOC working group is a stakeholder for this work, and thus wants to track it on their project board. labels Apr 8, 2026
@FilOzzy FilOzzy added this to FOC Apr 8, 2026
@github-project-automation github-project-automation bot moved this to 📌 Triage in FOC Apr 8, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a dedicated developer-focused guide to the repository and updates the main README to link to it, keeping end-user documentation lighter while centralizing contributor workflows and debugging tips.

Changes:

  • Add DEVELOPMENT.md with setup steps, common scripts, CLI workflows, and troubleshooting/debugging guidance.
  • Replace the long “Development” section in README.md with a link to DEVELOPMENT.md.
  • Document local devnet usage and local synapse-sdk linking instructions.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
README.md Replaces inlined development instructions with a pointer to DEVELOPMENT.md.
DEVELOPMENT.md New development guide covering setup, scripts, CLI run modes, debugging, HTTP tracing, devnet usage, and local SDK linking.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@rvagg rvagg requested a review from BigLep April 8, 2026 18:38
@BigLep BigLep moved this from 📌 Triage to 🔎 Awaiting review in FOC Apr 8, 2026
@BigLep BigLep requested a review from SgtPooki April 8, 2026 22:52
Copy link
Copy Markdown
Member

@BigLep BigLep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff - I like it.

I put @SgtPooki down for visibility, but this seems great to me!

@github-project-automation github-project-automation bot moved this from 🔎 Awaiting review to ✔️ Approved by reviewer in FOC Apr 8, 2026
@rvagg rvagg merged commit d6df4cb into master Apr 9, 2026
12 checks passed
@rvagg rvagg deleted the rvagg/development.md branch April 9, 2026 15:31
@github-project-automation github-project-automation bot moved this from ✔️ Approved by reviewer to 🎉 Done in FOC Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team/filecoin-pin "Filecoin Pin" project is a stakeholder for this work. team/fs-wg FOC working group is a stakeholder for this work, and thus wants to track it on their project board.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants