SATVILab / projr

Streamline R projects
https://satvilab.github.io/projr/
Other
1 stars 1 forks source link

Allow `docs-<subkey>` directories for non-rendered files #531

Open MiguelRodo opened 3 months ago

MiguelRodo commented 3 months ago

To do

Initial 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 open docs up to non-computed artefacts).

Possible options:

1.

`docs`: docs
`docs-raw`: _docs
`docs-render`: docs
`docs-raw`: docs_raw

Gemini discussion

https://g.co/gemini/share/541165fe28d0

MiguelRodo commented 3 months ago

Final decision

The final decision for organizing your documentation within the YAML configuration is as follows:

  1. 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).
  2. 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.