Update to Documentation!

[Inventhrice]

This is the work I've done so far for the documentation! Let me know your thoughts :)

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.00%. Comparing base (bce38f0) to head (28c7d71).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #579      +/-   ##
==========================================
+ Coverage   79.69%   81.00%   +1.31%     
==========================================
  Files         137      137              
  Lines       13467    11083    -2384     
==========================================
- Hits        10732     8977    -1755     
+ Misses       2310     1680     -630     
- Partials      425      426       +1     

Flag	Coverage Δ
unittests	81.00% <ø> (+1.31%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[creativeprojects]

I'll have a look at it during the week or at the week-end, thank you for your help 👍🏻

[Inventhrice]

Just wanted to bump this to bring to your attention! Lemme know if the direction this is heading at is looking good!

[creativeprojects]

Hi!

I finally got a bit of time to look at it.
I can see the reorganisation of the chapters makes sense to me, that's nice, thank you 👍🏻

Sadly I can't try to view the result locally, I get an error on building it with Hugo:

ERROR [en] REF_NOT_FOUND: Ref "/reference/jsonschema": "/go/src/github.com/creativeprojects/resticprofile/docs/content/configuration/profiles/editorConfig.md:7:64": page not found

Are you using a different version of Hugo by any chance?

[Inventhrice]

Ah! I see what's happened. To explain:

1. "/reference/jsonschema" wasn't found in /docs/content/configuration/profiles/editorConfig.md:7:64
2. Checking my repo, /docs/content/reference is empty

This is different than my working version, which has the following under the same dir:

I've pushed a change that just updates the link, it should be good!

[creativeprojects]

Cool I can browse the doc locally, it's easier to see that way 👍🏻
I'm not too sure why the pipeline is failing: it works when I run the script to check all the links locally (via make checklinks)

[Inventhrice]

Build looks to be failing at the check broken links, which makes sense/is to be expected (seeing as the update to the docs would move a lot of the links around)

[Inventhrice]

Hi! Pushed a couple of updates to this, here's the update:

I'm taking another sweep through of the documentation to rework it again. I'm not particularly trained in this field unfortunately, but I am trying to emulate some of my favorite documentation (such as ntfy).

The main area I'd like to tackle (slowly but surely) is the reference section, as I've noticed some information being out of date or being incorrect (the schedule-after-error YAML example comes to mind). But! It'll get done slowly but surely :).

I am using Diataxis to guide how I edit the information. I still aim to keep all the information intact, but just condensed as per the needs of the section. Eg, the installation section got cut to pieces, to make it really condensed. This follows the 'How To' sector of Diataxis, and anything that doesn't fall under it has (so far) been put into either /faq.html or /reference/docker.

[creativeprojects]

Thanks for your help; I'll have a look at it.

You don't need to do a big bang rewrite of the documentation; small changes in their own pull requests help improve things gradually 👍🏻

[Inventhrice]

Many thanks :D ! Yes, you do raise an excellent point re: not doing it in one shot, and likewise on my end, no rush on reviewing the docs on my part! I'll mark the PR away from Draft when I feel like I've sufficiently completed a part of it!