Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dropdown versioned docs #58

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open

dropdown versioned docs #58

wants to merge 24 commits into from

Conversation

hanbollar
Copy link
Contributor

@hanbollar hanbollar commented May 20, 2024

Fixes #29

following common conventions for documentation pages

  • going to have 'docs.mrjs.io' reroute to 'docs.mrjs.io/v/latest'
  • right now copying directly from previous public-versioning saves
  • create and add the actual drop down section (going to get help from lobau for design of this once setup as functioning)
  • ... more todos
  • switch render.com to use all-versions-smoo.sh

foldering:

  • public/v/main: what is directly on MRjs main
  • public/v/latest: a copy of what is the latest version release
  • public/v/vX.Y.Z: whatever version release it is

in future, might want to capture and actually rebuild previous versions with previous smoo.sh runs (that's more involved so leaving as future todo)

Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Copy link

render bot commented May 20, 2024

Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
@hanbollar
Copy link
Contributor Author

forgot to mention - had to switch, for the versions we had available, to actually rebuilding from their specific smoo.sh because relative links and full domain links, etc

  • versions that will be pure copy from public (because theyre not documentation version stamped)
    • v0.5.4
    • v0.6.0
    • v0.6.1
  • versions that can be rebuilt with smoo.sh
    • v0.6.2
    • v0.6.3
    • v0.6.4

copying:

  • we'll be doing a copy into all-saved/main so that is always updated on regular smoo.sh run
  • we'll be doing a copy of whatever is the most recent version to /latest/ as well on the all smoo.sh run

Signed-off-by: hanbollar <[email protected]>
@hanbollar
Copy link
Contributor Author

hanbollar commented May 21, 2024

next - add version and relative to _template for the main run, then i should be able to duplicate that across the versions

Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
Signed-off-by: hanbollar <[email protected]>
@hanbollar
Copy link
Contributor Author

@lobau - i'm going to walk this through with you tomorrow as it's at a state where 'it works' but there's a few things i wanted to check with you for final polish before i merge this in - i'm going to put this on the back burner for this week though now since it's basically completed

@hanbollar hanbollar changed the title WIP - start on dropdown versioned docs dropdown versioned docs May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

documentation versioning on the docs page
1 participant