Skip to content

Add Navbar to Documentation Pages for All Releases After "Latest Code Documentation" #83

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

Closed
wants to merge 3 commits into from

Conversation

divine7022
Copy link
Contributor

Fixed: #82

This PR adds a navbar to the documentation pages for all releases listed after "Latest Code Documentation." Previousl , these versioned documentation pages did not have a navbar, making navigation inconsistent. This update ensures that users can easily switch between different documentation versions without relying on external links or manual navigation.

Befor:
Screenshot 2025-02-16 113800

After:
Screenshot 2025-02-16 113728

Let me know if you need any modifications! 🚀

Looking forward to your( @dlebauer ) response. Thanks in advance!

@divine7022 divine7022 changed the title Add Navbar to Documentation Pages for All Releases After "Latest Code Documentation" #82 Add Navbar to Documentation Pages for All Releases After "Latest Code Documentation" Feb 16, 2025
@divine7022
Copy link
Contributor Author

@dlebauer Looking forward to your response. Thanks in advance!

@dlebauer
Copy link
Member

thanks for this change! Could you please resolve conflicts in documentation.js? https://github.com/PecanProject/PecanProject.github.io/pull/83/conflicts

@divine7022
Copy link
Contributor Author

thanks for this change! Could you please resolve conflicts in documentation.js? https://github.com/PecanProject/PecanProject.github.io/pull/83/conflicts

@dlebauer Okey, I'll resolve it soon.

@divine7022
Copy link
Contributor Author

thanks for this change! Could you please resolve conflicts in documentation.js? https://github.com/PecanProject/PecanProject.github.io/pull/83/conflicts

@dlebauer solved the conflict in the documentation.js click here to review.

@divine7022
Copy link
Contributor Author

divine7022 commented Feb 19, 2025

@dlebauer The conflict in documentation.js was due to the missing 'V' added to Release 1.7.0, which was already merged before this PR. To resolve it, I created a new branch from the latest code and submitted a fresh PR .
Let me know if any further changes are needed! Thank you

@dlebauer
Copy link
Member

@divine7022 thanks for doing this, though I am not sure I fully understand - it looks like, compared to this PR, #89 just changes urls to relative paths?

Would it make sense to change the base branch of 89 so that it is proposing changes to divine7022:fix-bug? (see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)

I went ahead and resolved the conflicts on this branch since it seemed clear that the intent was to add the Documentation() function FYI in case this wasn't clear - here are GitHub docs resolving conflicts in GitHub.

Thanks again for your help with this!

@divine7022
Copy link
Contributor Author

@divine7022 thanks for doing this, though I am not sure I fully understand - it looks like, compared to this PR, #89 just changes urls to relative paths?

Would it make sense to change the base branch of 89 so that it is proposing changes to divine7022:fix-bug? (see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)

I went ahead and resolved the conflicts on this branch since it seemed clear that the intent was to add the Documentation() function FYI in case this wasn't clear - here are GitHub docs resolving conflicts in GitHub.

Thanks again for your help with this!

@dlebauer Thanks for your valuable feedback!
The previous PR #83 contained already merged changes which causing a conflict. To ensure a clean update, I cloned the latest repo to a fresh folder, created a new branch, and made only the required changes before submitting PR #89. Let me know if any adjustments are needed!

@dlebauer
Copy link
Member

dlebauer commented Feb 20, 2025

@divine7022 sorry, should I still merge both? Also, this one has a failed build after resolving conflicts

@divine7022
Copy link
Contributor Author

@divine7022 sorry, should I still merge both? Also, this one has a failed build after resolving conflicts

@dlebauer No worries!
PR #89 contains the clean and required changes. I recommend merging only #89 and ignoring #83.

Thanks for your review!

@dlebauer dlebauer closed this Feb 20, 2025
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.

Fixed Navbar Issue in Documentation Pages for All Releases After "Latest Code Documentation"
2 participants