docs: explain docs folder layout #1830
Open
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
|
|
|
Looks good. I might suggest that your added part goes in a new section called e.g. "Documentation folder locations", that goes beneath "Building documentation locally". |
MargaretDuff
approved these changes
Jun 12, 2024
| @@ -88,6 +88,43 @@ Rendered | |||
| Building documentation locally | |||
| ------------------------------ | |||
|
|
|||
| Folder layout: | |||
There was a problem hiding this comment.
Suggested change
| Folder layout: | |
| The `CIL/docs` folder containers the scripts and sources for building the CIL website and documentation. The folder contains: |
DanicaSTFC
reviewed
Jun 12, 2024
There was a problem hiding this comment.
The additional information are great!
My main comment is "what do we mean by documentation?" Is it everything including the readme files, the website and also the docs? I think "Building documentation locally" should be the instructions on how to build the documentation (in the docs). Perhaps the title needs changing or we should split this into more sections. Like "Website" vs "Documentation i.e. the page Casper created. In this way it should be clearer.
casperdcl
force-pushed
the
master
branch
3 times, most recently
from
a910556
to
f8b513b
Compare
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.
Related issues/links
Part of #1579
Checklist
I have performed a self-review of my codeI have added docstrings in line with the guidance in the developer guideI have implemented unit tests that cover any new or modified functionalityCHANGELOG.md has been updated with any functionality changeContribution Notes
Please read and adhere to the developer guide and local patterns and conventions.