...
draw.io Diagram | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
File structure
Eventually, we will have all .md of docs files on master, thus allowing the docs change with code change to be committed in a single PR. The automation scripts to generate the docs content will also be on master. To start with, we will still keep all docs files on a separate branch, i.e., asf-site.
Versioning docs
The release-specific documentation (release docs) should documentation should evolve with the code changes. Thus, maintaining we need to version the docs regarding design, implementation details and API examples on master under /docs would make things easieraccording to each release version. In this way, the code and the corresponding docs change can coexist in the same PR. Specific pages around these include:
...