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

The documentation is missing versioning #36

Open
1 task done
Ludee opened this issue Aug 9, 2023 · 3 comments · Fixed by #47
Open
1 task done

The documentation is missing versioning #36

Ludee opened this issue Aug 9, 2023 · 3 comments · Fixed by #47
Assignees
Labels
part: docu 📖 Improvements or additions to documentation priority: high ⚡ High priority status: active 🚧 Work in progress type: feature 🛠️ New feature or request

Comments

@Ludee
Copy link
Member

Ludee commented Aug 9, 2023

Description of the issue

The documentation is missing versioning.
The MkDocs should be specific to each software version.

Ideas of solution

There is a specific package called mike to handle the versions.
Sources:

Workflow checklist

@Ludee Ludee added the type: enhancement ⚙️ Improvement of an existing feature label Aug 9, 2023
@Ludee Ludee added this to the Complete repository milestone Aug 9, 2023
@Ludee Ludee self-assigned this Aug 9, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
Ludee added a commit that referenced this issue Aug 11, 2023
@Ludee Ludee closed this as completed in #47 Aug 11, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
@Ludee Ludee mentioned this issue Aug 14, 2023
5 tasks
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
Ludee added a commit that referenced this issue Aug 14, 2023
@Ludee
Copy link
Member Author

Ludee commented Aug 15, 2023

In order to have the version slider on older versions before mike has been implemented, simply add it to mkdocs.yml after checking out the Git Tag and then register the version with mike.

@Ludee Ludee added part: docu 📖 Improvements or additions to documentation type: feature 🛠️ New feature or request status: active 🚧 Work in progress priority: high ⚡ High priority and removed type: enhancement ⚙️ Improvement of an existing feature labels Aug 17, 2023
@Ludee
Copy link
Member Author

Ludee commented Aug 17, 2023

In order to have the latest develop branch with mike versioning, update the stale GitHub workflow to push the develop branch after a PR.

Ludee added a commit that referenced this issue Aug 17, 2023
Ludee added a commit that referenced this issue Aug 17, 2023
Ludee added a commit that referenced this issue Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: docu 📖 Improvements or additions to documentation priority: high ⚡ High priority status: active 🚧 Work in progress type: feature 🛠️ New feature or request
Projects
None yet
1 participant