Skip to content

Initial user-facing docs site#70

Draft
detjensrobert wants to merge 26 commits into
mainfrom
dr/create-docs
Draft

Initial user-facing docs site#70
detjensrobert wants to merge 26 commits into
mainfrom
dr/create-docs

Conversation

@detjensrobert

@detjensrobert detjensrobert commented Aug 19, 2025

Copy link
Copy Markdown
Contributor

Adds documentation for end users, both ctf/infra admins and challenge authors. Not complete yet.

This uses Vitepress as the SSG. I chose this because it looked good, is fast, auto dark mode, and has good TOC sidebar management for organization.

This is deployed to beavercds.info via GH Pages.

…text

This is what docker, podman, etc all do and we should match that expected
behaviour here.

Signed-off-by: Robert Detjens <github@detjens.dev>
text is less intuitive than string since we all are programmers and strings
are strings, not text

Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Found this missing case when writing docs. Specifiying `include:` as a single
string should be equivalent to specifying a bare string, which is already
treated as a one-element array.

Renaming only happens when as: is present, and we should support the
`include:` single string like a 1-element array, like the bare string case.

Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
The top-level nav would be useful if we wanted to have multiple 'categories'
of pages with separate sidebars. Right now at least, we only have a few
pages and the sidebar covers all of our nav needs.

Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>
Signed-off-by: Robert Detjens <github@detjens.dev>

@cacama-valvata cacama-valvata left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"Control Challenge Deployment" on the landing page throws a 404

@cacama-valvata

Copy link
Copy Markdown
Contributor

Finish rcds.yaml reference before considering this done

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.

2 participants