SciCatProject / scicatproject.github.io

SciCat Data Catalogue Documentation Website
https://scicatproject.github.io/
0 stars 5 forks source link

Towards changes for documentation to be repository specific #50

Closed LAShemilt closed 1 month ago

LAShemilt commented 3 months ago

Introduction

This PR makes changes to the SciCat Website to make it a more user and developer friendly resource for documentation.

In order to make this change there are a few larger structural changes to be made across the Scicat project which will be formed as part of companion pull requests into repositories. The proposed changes are these:

1) the ScicatProject/documentation repository becomes the User guide only, this will be eventually integrated into this website 2) All the repositories will have their own documentation. This can be easily amended when a developer makes a change to the website. 3) The existing information in the Developers part of the documentation will go into backend docs, and frontend docs. 4) All documentation will be linked to through the website.

Proposed changes

nitrosx commented 3 months ago

Honkit is the tool that we currently use to build the documentation pages.

https://honkit.netlify.app/