envoyproxy / envoyproxy/envoy

[RFC] Move developer docs to main docs (or at least to an .rst tree)

Open
#13,431 17 comments 0 reactions 0 assignees View on GitHub
area/docs help wanted
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 20h
Merged PRs (30d)
437

Description

## description

At the moment there are a lot of useful dev docs/info spread through files in the repo.

I believe there are several advantages to centralizing the developer docs and bringing them into the main documentation

- we have various ci/checks etc that are only applied to the doc/rst tree
- centralizing docs would decrease the learning time/curve for new developers to find relevant documentation/adopt related standards etc
- one set of documents to maintain (altho i think there is an argument for maintaining the dev docs in a separate tree - but then 2)

we could still leave stubs/links in README files or similar

perhaps this pertains differently to code documentation in the actual source etc than to eg ci/tooling/sandbox docs - but even then there maybe a similar argument to collate the developer docs.

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.