Add: A light weight documentation footer above the site footer. (Issue: #405)#834
Open
Aayushman-nvm wants to merge 1 commit intoprecice:masterfrom
Open
Add: A light weight documentation footer above the site footer. (Issue: #405)#834Aayushman-nvm wants to merge 1 commit intoprecice:masterfrom
Aayushman-nvm wants to merge 1 commit intoprecice:masterfrom
Conversation
MakisH
added
GSoC
Contributor
|
This pull request has been mentioned on preCICE Forum on Discourse. There might be relevant details there: https://precice.discourse.group/t/introduction-website-modernization/2852/1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Footer
Adds a lightweight documentation footer above the site footer.
Addresses Issue #405
Features:
Design considerations
The implementation intentionally remains minimal and migration-safe since the documentation site will migrate from Jekyll to Hugo in the near future.
Features that require additional infrastructure (feedback forms, contributor lists, GitHub API usage) are intentionally not implemented here and can be reconsidered after migration.
Future improvements
Once the documentation system migrates to Hugo, themes such as Docsy could provide additional functionality including:
Note:
This PR intentionally omits section-aware Discourse links (e.g. linking to "Installing preCICE" when browsing installation docs). This would require a
section:front matter field to be added across doc pages. Happy to open a follow-up issue for this if the team think it's worth pursuing._data/discourse_map.ymlis included as a reference for the planned section-aware Discourse links but is not actively used in this PR.content/docs/fundamentals/fundamentals-overview.mdis the only file where this appears for now. Will add it to other doc pages similarly.Screenshot: