Replace link to doxygen with link to guides and fix link to deprecated doxygen pages #150
Conversation
|
🚀 PR preview deployed to https://RIOT-OS-riot-os-org-preview-150.surge.sh |
_includes/header.html
Outdated
| <li><a href="https://www.hackster.io/riot-os" target="_blank">[email protected]<i class="bi bi-box-arrow-up-right align-text-bottom"></i></a></li> | ||
| <li><a href="{% link index.html %}#faq">FAQ</a></li> | ||
| <li><a href="https://doc.riot-os.org/" target="_blank">Documentation <i class="bi bi-box-arrow-up-right align-text-bottom"></i></a></li> | ||
| <li><a href="https://guide.riot-os.org/" target="_blank">Documentation <i class="bi bi-box-arrow-up-right align-text-bottom"></i></a></li> |
There was a problem hiding this comment.
I don't think we should totally kill the reference to the Doxygen documentation just yet.
There was a problem hiding this comment.
There is a link to the Doxygen documentation at guide.riot-os.org
There was a problem hiding this comment.
I don't think we should totally kill the reference to the Doxygen documentation just yet.
So you suggest to wait for RIOT-OS/RIOT#21708 to land first?
There was a problem hiding this comment.
There is a link to the Doxygen documentation at guide.riot-os.org
We could add a "API Documentation" or "Doxygen Docs" or similar.
There was a problem hiding this comment.
Okay I added an extra API Documentation link
There was a problem hiding this comment.
Maybe now rename the old documentation link "Guides" or "User Guides" or "User/Developer Guides" (I prefer the first actually)? It looks weird now that the one link says "Documentation" and the other "API Documentation", and I think with other FOSS projects they usually use the same pattern.
There was a problem hiding this comment.
Okay I have now renamed the link to the new guides to Guides, while still calling the doxygen one API Documentation so it more clear what is what
|
Please squash :) |
LasseRosenow
force-pushed
the
replace-doxygen-link-with-guides-link
branch
from
1581836 to
e9d524f
Compare
|
Done :) |
All of the user documentation now lives under https://guide.riot-os.org.
Progress was tracked under:
So I changed the link to the documentation to the guides site, which contains the most useful documentation for beginners.
The API-Documentation (doxygen) is linked there very prominently as well, so it is still easy to discover.
Furthermore some links pointed to outdated user documentation that just shows an empty deprecated page. I updated these to the guide documentation counterparts as well.