envoyproxy / envoyproxy/envoy

Consolidate developer docs

Open
#29,957 5 comments 0 reactions 0 assignees View on GitHub
area/dev area/docs no stalebot rfc
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 22h
Merged PRs (30d)
430

Description

Currently the developer docs are scattered in readmes in the repo

this has the benefit of being close to the action, but makes it difficult if you dont know the repo to know where the authoritative (if limited) scribblings are

the conversation previously has been mostly around publishing rst dev docs, either as part of or separate to existing docs

this add quite a bit of constraint/overhead to devs updating the docs

one possibility is we move the readmes to the wiki (and i guess increase write access to that)

this would at least allow easier structuring/linking/etc but without the constraints of producing valid/well-formed rst

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.