You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Allow docs-<subkey> directories for non-rendered files
Initial thoughts
Not sure how this would look... But I usually have to add a data-rawdocs sub-directory for, e.g. scrap, scripts, presentations, etc.
The one issue is that docs feels to me like a jargon term, for where we keep like our site (GitHub uses that as its default). So I want to keep the keyword for that, but it's ambiguous (if we open docs up to non-computed artefacts).
The text was updated successfully, but these errors were encountered:
MiguelRodo
changed the title
Consider adding a docs directory that isn't for rendered files
Allow docs-<subkey> directories for non-rendered files
Jun 7, 2024
The final decision for organizing your documentation within the YAML configuration is as follows:
The docs keyword is reserved exclusively for rendered documentation (e.g., HTML files generated from qmd). This directory path is set to docs (by default; can be changed).
All other types of documentation (Word, PowerPoint, etc.) will be stored in directories with the prefix docs-. For example:
docs-source (for original source documents)
docs-slides (for presentation slides)
docs-reports (for reports)
and so on.
This approach provides a clear distinction between generated and non-generated documentation, while offering flexibility to accommodate various document types in a structured manner.
To do
docs-<subkey>
directories for non-rendered filesInitial thoughts
Not sure how this would look... But I usually have to add a
data-raw
docs
sub-directory for, e.g. scrap, scripts, presentations, etc.The one issue is that
docs
feels to me like a jargon term, for where we keep like our site (GitHub uses that as its default). So I want to keep the keyword for that, but it's ambiguous (if we opendocs
up to non-computed artefacts).Possible options:
Gemini discussion
https://g.co/gemini/share/541165fe28d0
The text was updated successfully, but these errors were encountered: