format icon indicating copy to clipboard operation
format copied to clipboard

[Website] Create a view per version on the website

Open Baklap4 opened this issue 2 years ago • 6 comments

Suggestion

Currently the latest version is shown on the website. However it'd be nice to add previous version also to the website So we can direct everyone to the correct pages for each specific version

Use case

  • All tags used within a version are made clear
  • it's good for historical purposes

Extra info/examples/attachments

No response

Baklap4 avatar Dec 13 '23 19:12 Baklap4

Hmmm to make this easy i think we can create folders per version:

Latest (1.1.0): `/docs/index.html
0.1.0: `/docs/0.1.0/index.html
0.2.0: `/docs/0.2.0/index.html
0.3.0: `/docs/0.3.0/index.html
1.0.0: `/docs/1.0.0/index.html

I guess we can keep the assets (css, js, images, fonts) within the root docs directory and reference them correctly from our index.html

Baklap4 avatar Dec 30 '23 20:12 Baklap4

Is there currently a proposed or accepted feature that significantly changes the syntax of the format? If not I think it would be easier to annotate each of the header fields and note types with a Since and/or Deprecated and/or Removed. For example:

#TITLE
Since: Version 0.1.0

#ENCODING
Since: Version 0.2.0
Deprecated: Version 0.3.0
Removed: Version 1.0.0

This would avoid duplication and still make clear which features are available in which version of the format.

codello avatar Jan 29 '24 11:01 codello

maybe as an inspiration: website: https://homieiot.github.io/specification/ spec: https://github.com/homieiot/convention website SSG: https://github.com/homieiot/homieiot.github.io they use a static site generator and git tags/branches for versioning

swurzinger avatar Jan 29 '25 23:01 swurzinger

Thanks @swurzinger, that is very helpful. My stance on this issue has changed a little since my last comment. I do agree that a view per version can be very helpful because multiple versions of the spec are "alive" at the same time. I think this also relates back to the current discussion in #66 and the way we want versioning of the file format to work.

I'm not a big fan of using branches or tags for this though because it makes it more difficult to work with multiple versions of the spec at the same time (and I see no real benefit to just using multiple files/folders).

codello avatar Jan 30 '25 10:01 codello

@codello @Baklap4 , since we now have 3 separate markdown-files for each Version, is it possible to render the 3 files in the website easily? Maybe using a tabs function? so it could be somewhat like @swurzinger suggested?

marwin89 avatar Apr 14 '25 14:04 marwin89

Should be pretty doable especially if we keep the website next to the published state within the same branch - A single source of truth

Baklap4 avatar Apr 17 '25 18:04 Baklap4