Open
Description
Many famous open source projects put the doc into the same repo of the source code. For instance:
APISIX: https://github.com/apache/apisix/tree/master/docs
Envoy: https://github.com/envoyproxy/envoy/tree/main/docs
Some projects even put the website into the same repo:
Pulsar: https://github.com/apache/pulsar/tree/master/site2/website
Here I suggest higress merge this repo into https://github.com/alibaba/higress.
Pros:
- People can update the doc in the same PR as the code change
- More activities can happen in the one repo
- It's easier for people to open the issue in the correct place. All issues (for doc / for code / for website) can go to one place and there is no need to move/track them in several places.
Cons:
- Increase the main repo's size. But this is trivial under the developer's modern network environment.
Metadata
Metadata
Assignees
Labels
No labels