Draft: adding initial docs repo #168
Closed
Conversation
This file contains 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
|
can the "SciCat official website" simply link the README? or is the HTML page required? I am a little afraid of code duplication (and maintenance) here |
minottic
requested review from
a team
and removed request for
consolethinks,
minottic and
fpotier
|
or maybe, could the html be auto generated from the .mds? |
|
The idea that the "official" scicat webpage would link out to a set of autogenerated docs on a https://github.io page. |
yes that is the plan, to use the github workflow to auto generate html from readmes. |
…ing the readme file to a very short guide, linking to the documentation
LAShemilt
force-pushed
the
adding-documentation
branch
from
30c768e to
c98899c
Compare
|
closed by #217 . @LAShemilt I have added the CI for mkdocs as a start, happy to review it after the documentation decision is more mature. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
adding a docs file and Github pages workflow to SciCat live to form a documentation that sits next to the repository.
Docs will be published through Github workflows when main is updated.
This will be referenced in the SciCat official website as the "Getting Started" guide. See the companion PR here: SciCatProject/scicatproject.github.io#50