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

Strategy for consolidation of hyperlinks to central documentation #93

Open
1 of 5 tasks
al-fisher opened this issue Nov 27, 2023 · 0 comments
Open
1 of 5 tasks

Comments

@al-fisher
Copy link
Member

al-fisher commented Nov 27, 2023

Following/as part of close out of #92 and the restructuring of documentation navigation...
A suggested strategy for consolidation of hyperlinks

We have a large number of references to various sub-pages of the BHoM docs across READMEs and other locations from outside of the BHoM documentation itself.
Suggesting a series of possible actions to consolidate curated links to small number of core repos and locations.
With the wider repos and standard templates being simplified to just point to high level https://bhom.xyz/documentation/ (as the search now is pretty good!)

Then suggesting we set up GitHub actions specifically on these small numbers of repos to potentially support the checking validity of URLs.
This can be in support of wider review of documentation strategy for our code being looked at by @travispotterBH, @michaelhoehn and others too.

We should also create a Documentation page outlining our documentation strategy. (We already have a nice page on editing, but one to outline the structure and approach will be good 🐶🥫 😄)

So a proposed list of actions for closing out or raising as discrete issues as appropriate are below:

@alelom, @FraserGreenroyd fyi

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

No branches or pull requests

1 participant