Where do we put the design documents?

[jackwener]

If a PR has a corresponding design document, where should we put the document publicly?

[Shylock-Hg]

Better to be public.

[jackwener]

If a PR has a corresponding design document, where should we put the document publicly?

Google doc, or other option ?

[Shylock-Hg]

What's the problem?

[jackwener]

It means that we must put the doc inside PR. The doc sometime just record code flow, and it isn't formal (sometime in Chinese)

[wey-gu]

How about WIP documented in google doc or a discussion/issue? and finally moved to https://github.com/vesoft-inc/nebula/tree/master/docs/rfcs ?

[wey-gu]

And dev docs could be rendered from https://github.com/vesoft-inc/nebula/tree/master/docs/rfcs easily with different github tags

[Shylock-Hg]

Put it in PR is better to be reviewed.

[wey-gu]

Or in the design flow, we firstly review and merge the RFCs PR before reviewing the implementation PR.

There could be a lite version of RFCs in issues/google docs(should be easier to be accessed and long-lived) before/during the RFC PR

And dev docs could be rendered from https://github.com/vesoft-inc/nebula/tree/master/docs/rfcs easily with different git tags

[Shylock-Hg]

It's great.

[wey-gu]

TiKV puts RFCs in a repo: https://github.com/tikv/rfcs

[wey-gu]

A short but clear post by @Xuanwo https://xuanwo.io/reports/2021-26/