agent-substrate / agent-substrate/substrate

Need a substrate developer troubleshooting guide

Đang mở
#583 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
area/observability kind/docs
Ngôn ngữ chính
Go
Star
1.8k
Fork
316
Merge trung bình
2 ngày 43 phút
Pull request đã merge (30 ngày)
287

Mô tả

## Summary

Substrate has good documentation for the happy path and none for what happens when it breaks.

- `README.md` — quickstart, both kind and GKE. Assumes everything works.
- `CONTRIBUTING.md` — process, PR sizing, root-gated tests, copyright headers.
- `AGENTS.md` — layout, build/test command reference.
- `docs/dev/code-layout.md` — where code goes.

So a contributor whose image didn't update, whose lint output is silently truncated, or whose e2e run fails on a laptop has nothing to consult. Substrate is a harder-than-average project to debug: gVisor and micro-VM sandboxes, snapshot/restore, a custom network path, a control plane deliberately outside the Kubernetes control plane, and two very different deployment targets — and the traps are mostly **silent or misleading**, not loud.

This issue asks for `docs/dev/troubleshooting.md`, organized by where you are in the dev loop.

---

## Scope

Contributors working *on* Substrate. Distinct from the two other guides: the actor developer (building workloads on Substrate) and the operator (running a fleet).

A telemetry-specific troubleshooting draft already exists as a sibling issue; it should either become a section here or stay a linked companion. Recommend companion — it is deep enough to stand alone, and this guide should link to it rather than absorb it.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.