aptos-core icon indicating copy to clipboard operation
aptos-core copied to clipboard

[Docs] Testing docs versioning.

Open rajkaramchedu opened this issue 2 years ago • 3 comments

Testing the docs versioning feature of Docusaurus. DRAFT only.


This change is Reviewable

rajkaramchedu avatar Jul 28 '22 00:07 rajkaramchedu

Can we converge on this. My concern is that in general the docs don't really disagree. We also don't have a lot of SDK docs where versioning is much more relevant. We have tutorials and guides. These guides and tutorials could become messy if we version like this. Personally, I don't want to invest the energy here, we're too small, we won't have that many situations like this, especially post launch. Just a few more weeks of craziness.

davidiw avatar Jul 28 '22 02:07 davidiw

Correct. The docs that need versioning are mainly AIT-specific ones. We have called out those docs in a separate section already. Moreover, and I have not tested this, when we version like shown in this PR, I think we have to push updates to common docs multiple times, one in each version. In any case, I wanted to show how versioning will be done, if we go down that path.

rajkaramchedu avatar Jul 28 '22 15:07 rajkaramchedu

While this is slick. I worry that we'll get ourselves in trouble here due to increase complexity in navigation. I would be supportive of making this for SDKs though.

davidiw avatar Jul 29 '22 04:07 davidiw