Skip to content

Conversation

@JosiahParry
Copy link
Member

Update docs

  • Replace "services" with "Apps" in item overview
  • Cleans up quickstart a smidgen

New docs

Admin Docs

  • Add Configuration overview for admin docs
  • Add Authentication section for admin docs
  • Add User Roles section for admin docs
  • Add empty Execution Engine section for admin docs

User Docs

  • Adds Access and Permissions doc for user guides

@ricochet-bot
Copy link

ricochet-bot commented Jan 4, 2026

Surge PR preview deployment succeeded. View it at https://ricochet-rs-docs-pr-95.surge.sh

@JosiahParry JosiahParry requested a review from pat-s January 4, 2026 17:05
@JosiahParry JosiahParry changed the title doc: doc: add admin configuration docs and user access Jan 4, 2026
@JosiahParry JosiahParry changed the title doc: add admin configuration docs and user access docs: add admin configuration docs and user access Jan 6, 2026
Copy link
Member

@pat-s pat-s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to discuss two high-level topics on the base of this PR:

  • Whether to move forward with the "you" style or not.

    Right now many sections are written as "Add the following to your ricochet-config.toml:" whereas it could also be "Add the following to ricochet-config.toml:".

    I personally favor the latter. It reads more "professional" and less "like a friend" style and also avoids many "you|yours" etc words which don't change the sentence meaning.

  • "One sentence per line": I know this is and will forever be a philosophical task but I am one of these persons who strongly believes markdown should be written that way. It helps with reviewing a lot and avoids long line and leads to a good reading flow (of the source). Line breaks don't change the markdown alignment, only adding two empty spaces at the end of a line forces a real line break. To me it makes a lot of sense to hit "enter" after a dot and continue with the next sentence :)

Comment on lines 9 to 11
A **task** is one that runs to completion such as R/Julia scripts and Quarto documents.
A **Task** runs to completion such as R/Julia/Python scripts and Quarto documents.

All tasks can be [scheduled](/v0-1/user/content-items/4-scheduled-content) (or [invoked via API](/v0-1/user/tasks/1-invoke)). A subset of tasks can be served as a [**static html** website](/v0-1/user/content-items/3-static-content)—for example R Markdown and Quarto documents or websites.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A Task runs to completion such as R/Julia/Python scripts and Quarto documents.
All tasks can be scheduled (or invoked via API).
A subset of tasks can be served as a static html website—for example R Markdown and Quarto documents or websites.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a suggestion may have been messed up here


## Setting Access and Permissions

1. Navigate to your item's settings page
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use Astro <Steps> component for such parts

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in this case looks a little lacking. Thoughts?
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need line breaks between the items to make it look "good".

@JosiahParry
Copy link
Member Author

I am a-okay not using 2nd person.

I will not be able to perfect a one line per sentence in markdown. That's nearly 2 decades of typing behavior :/ I can try but it shouldn't prevent merging. If we we can make just fmt can handle that, great! Otherwise, that's asking too much!

will address requested edits

@pat-s
Copy link
Member

pat-s commented Jan 6, 2026

I will not be able to perfect a one line per sentence in markdown. That's nearly 2 decades of typing behavior :/ I can try but it shouldn't prevent merging. If we we can make just fmt can handle that, great! Otherwise, that's asking too much!

Alright, I understand that! Please see if #101 works for you!

@JosiahParry
Copy link
Member Author

@pat-s mind giving this another once over? Changes should be taken into account here. Feel free to make any changes you see fit.

Though, I think the editorconfig lint needs to be adjusted. It's showing an issue with the number of spaces in the quickstart. But looking at

docs ⚡ just lint
bun prettier --check .
Checking formatting...
All matched files use Prettier code style!

this should pass the lint check

@pat-s
Copy link
Member

pat-s commented Jan 7, 2026

Editorconfig is correct. Indent here was at 3 (instead of 4). It doesn't align visually with numbered lists.

@pat-s
Copy link
Member

pat-s commented Jan 7, 2026

@JosiahParry I've cleaned up and make various QOL improvements:

  • Backticks render support for titles and sidebars
  • Increased content width a bit
  • Increased right sidebar width
  • Navigation at the page bottom is now "boxy"

Should have probably done these in a separate PR but here we are now 👀 Please have a look whether this looks good to you!

@JosiahParry
Copy link
Member Author

@pat-s looks good for me! Do you want to merge it?

@pat-s pat-s merged commit 376d7fd into main Jan 7, 2026
2 checks passed
@pat-s pat-s deleted the doc/enhance branch January 7, 2026 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants