docs: explain docs folder layout#1830
Conversation
|
|
|
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". |
| Building documentation locally | ||
| ------------------------------ | ||
|
|
||
| Folder layout: |
There was a problem hiding this comment.
| Folder layout: | |
| The `CIL/docs` folder containers the scripts and sources for building the CIL website and documentation. The folder contains: |
There was a problem hiding this comment.
This covers documentation outside of the CIL/docs folder so I think keeping heading as ' Folder layout' is fine
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
lauramurgatroyd
left a comment
lauramurgatroyd
left a comment
There was a problem hiding this comment.
hi @casperdcl I think this looks good, I'm not sure why it wasn't merged before.
Just one minor question.
I checked and still seems to be correct, and for reference looks like this rendered:
| Building documentation locally | ||
| ------------------------------ | ||
|
|
||
| Folder layout: |
There was a problem hiding this comment.
This covers documentation outside of the CIL/docs folder so I think keeping heading as ' Folder layout' is fine
Signed-off-by: Laura Murgatroyd <60604372+lauramurgatroyd@users.noreply.github.com>
Signed-off-by: Laura Murgatroyd <60604372+lauramurgatroyd@users.noreply.github.com>
5 participants
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.