ProperDocs Versioning Approach

[DevTwilight]

Current Version

ProperDocs 1.6.1 (based on MkDocs)

Discussion

How should we handle versioning for ProperDocs going forward?

Some questions to consider:

• Should we follow Semantic Versioning (MAJOR.MINOR.PATCH)?
• Should the first independent ProperDocs release start at 1.0.0, or continue from MkDocs’ numbering?
• How should we decide when to increment MAJOR, MINOR, or PATCH versions?
• Should version numbers indicate compatibility with MkDocs, or focus solely on ProperDocs-specific development?

I’d like the community’s input on establishing a clear and consistent versioning scheme for ProperDocs.

[oprypin]

The versioning approach that I'm thinking of:

Start from something greater than 1.6.1 (maybe greatly bump it to something like 1.6.5 or 1.7.0) but the initial release will be pretty much the same result as MkDocs 1.6.1

And follow the same approach as I've been following (you have to remember I've already been doing releases of MkDocs except the latest one)

• Major - permanently at 1
• Minor - for new features and possibly tiny breaking changes
• Patch - bugfixes and reverts of something in the current minor release.

This is not semver

[oprypin]

It's not next-gen mkdocs, it's current-gen

[ghost]

will u not add new feature?

[EddyLuten]

I agree with this approach and think it would be safer to start with something like 1.6.5 to avoid breaking people who've pinned their MkDocs version to 1.6.x (~1.6.0 semver). That way, the only thing that will have to change is the package name without further config.

[Andre601]

will u not add new feature?

The current goal is maintaining it.

[oprypin]

New features also possible but mkdocs is barely alive as is, so keeping it alive first is important.

[DevTwilight]

i prefer 1.6.x