Ability to turn off the "next" version / make editing docs easier
See original GitHub issueš„ Proposal
After cutting a version (eg 1.0.0), the docs exist at both docs/
and versioned_docs/version-1.0.0
. If for instance, I want to fix a typo, it seems like I would have to edit both copies anytime a change is made?
It seems like the versioning feature presumes I want a next
version. However, I only just released 1.0.0 with no breaking changes under development, so I donāt need or want a ānextā version, as itās just another place I have to maintain, and an additional point of confusion for my users.
Also, Iād like to be able to work on the structure of & improve my 1.0.0 docs, without having to create a new version of my library.
As a workaround, I have to make sure if a file exists in both folders to edit the āversionedā doc, and then run rsync -avr ./versioned_docs/version-1.0.0/ ./docs/
to make sure next
(which I donāt actually want) stays updated. Or another workaround is
ā rx-store-website git:(master) rm -fr versioned_docs/version-1.0 versioned_sidebars/version-1.0-sidebars.json
ā rx-store-website git:(master) ā ../../node_modules/.bin/docusaurus docs:version 1.0
One way to solve this would be to update versions.json
with a 1.0.0
entry, but have it point to ādocsā folder. Only later if & when I cut a new version would the āversioned docsā for 1.0.0
be added, so itād archive a version at the time it reaches end of life instead of when the version is released would be an improvement IMO. I think itād also have to invert the diffing to work (eg, archive everything, since you donāt know what will change in future versions, then later when you archive another version on top of that is the point in time in which youād prune files from the older versions that did not change)
Have you read the Contributing Guidelines on issues?
yes
Issue Analytics
- State:
- Created 3 years ago
- Comments:6
Iāve bookmarked the RFC to read later, what you described sounds exactly like it will solve the issue, and the workarounds I posted in the OP seem tenable in the meantime, so it is fine to remain closed. Thanks!
Sounds like you already have the feature I was suggesting then and it just wasnāt super obvious. Iāll try it out again in the future. For now I turned off versions because it was a bit cumbersome to edit the dupes files. Thanks for the reply!