Skip to content

docs: refresh user and dev documentation - #880

Open
mandre wants to merge 1 commit into
k-orc:mainfrom
shiftstack:revamp-docs
Open

docs: refresh user and dev documentation#880
mandre wants to merge 1 commit into
k-orc:mainfrom
shiftstack:revamp-docs

Conversation

@mandre

@mandre mandre commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Reorganize the docs for better usability, and refresh content.

@github-actions github-actions Bot added the semver:patch No API change label Aug 14, 2026
Reorganize the docs for better usability, and refresh content.

@dlaw4608 dlaw4608 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.

I like the new layout for the site, I installed zensical and ran it locally, it also includes day/night theme setting (which is great), In terms of the refreshed documentation the content make sense, it is easy to read, and very informative.

Read through everything, could not find any typos or grammar issues, only found one small thing regarding the log levels, but is a tiny fix. Overall this looks great!!! @mandre


| Level | Description |
|-------|-------------|
| 0 | Status messages: startup, shutdown |

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.

minor-fix: Is the log levels not mapped 1 -> 4? , If someone picked 2 --zap-log-level=2 expecting "Verbose" they would actually get "Info", I think the documentation is one behind the actual log levels as shown here see https://github.com/k-orc/openstack-resource-controller/blob/main/internal/logging/levels.go WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver:patch No API change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants