docs: Add multiuser documentation and reposition Workflows#9099
docs: Add multiuser documentation and reposition Workflows#9099lstein wants to merge 22 commits into
Conversation
joshistoast
left a comment
There was a problem hiding this comment.
Good overall add, but needs some updates.
Notes:
-
I added some quick suggestions for reordering to keep the non subgrouped docs links at the top of the respective parent group.
-
Lots of areas where the
<Steps>component can be used for those instructional step-by-step ordered lists. -
I think we should move the spec to the corresponding invoke dir as a feature readme, as opposed to being a docs page.
-
Found a couple broken links and left the fix suggestions.
-
The multi user docs leaves a lot of "not right now, but in the future for sure" promises, maybe it'd be better to just say "Not at this time, create an issue if this is important to you" verbiage?
-
There seemed to be an instance or two of inconsistency between existence of a feature. For example the user vs administrative docs seem to have different opinions on the existence of a user management webui. And there is also documentation now of a board having a desciption- which unless I'm mistaken doesn't exist.
-
I can have my LLM do another pass over this to see if I missed anything, but this was everything I found initially.
Co-authored-by: Josh Corbett <joshwcorbett@icloud.com>
Co-authored-by: Josh Corbett <joshwcorbett@icloud.com>
|
Thanks for the thorough review. There was a lot more cruft in the docs than I realized. I've implemented all the suggested changes and removed redundant and out-of-date content. Let me know if I missed anything. |
joshistoast
left a comment
There was a problem hiding this comment.
PR remains inconsistent with real behavior. Features that don't exist, incorrect endpoints, inaccurate and conflicting feature behaviors, etc.
Also we should document GET /api/v1/auth/status
|
|
||
| **Response:** | ||
|
|
||
| ```json |
There was a problem hiding this comment.
Returns a plain array, no pagination
There was a problem hiding this comment.
Shape needs to be:
[
{
"user_id": "string",
"email": "string",
"display_name": "string",
"is_admin": false,
"is_active": true,
"created_at": "2026-05-07T21:12:09.008Z",
"updated_at": "2026-05-07T21:12:09.008Z",
"last_login_at": "2026-05-07T21:12:09.008Z"
}
]
Returns a plain array without items
There was a problem hiding this comment.
Fixed for real this time.
Co-authored-by: Josh Corbett <joshwcorbett@icloud.com>
joshistoast
left a comment
There was a problem hiding this comment.
Found a few more things, clarified another thing. We're getting closer.
|
|
||
| **Response:** | ||
|
|
||
| ```json |
There was a problem hiding this comment.
Shape needs to be:
[
{
"user_id": "string",
"email": "string",
"display_name": "string",
"is_admin": false,
"is_active": true,
"created_at": "2026-05-07T21:12:09.008Z",
"updated_at": "2026-05-07T21:12:09.008Z",
"last_login_at": "2026-05-07T21:12:09.008Z"
}
]
Returns a plain array without items
| # Session configuration (multi-user mode only) | ||
| jwt_secret_key: "your-secret-key-here" # Auto-generated if not specified | ||
| jwt_token_expiry_hours: 24 # Default session timeout | ||
| jwt_remember_me_days: 7 # "Remember me" duration |
There was a problem hiding this comment.
| # Session configuration (multi-user mode only) | |
| jwt_secret_key: "your-secret-key-here" # Auto-generated if not specified | |
| jwt_token_expiry_hours: 24 # Default session timeout | |
| jwt_remember_me_days: 7 # "Remember me" duration | |
| # Optional password policy | |
| strict_password_checking: true # Enforce uppercase/lowercase/number requirements |
There was a problem hiding this comment.
These seem to still be present
There was a problem hiding this comment.
They should be gone for good.
Co-authored-by: Josh Corbett <joshwcorbett@icloud.com>
Co-authored-by: Josh Corbett <joshwcorbett@icloud.com>
…er' into lstein/docs/multiuser
… password requirement
ffee730 to
0863f51
Compare
joshistoast
left a comment
There was a problem hiding this comment.
Almost there, found a few more discrepancies, and some were even from my own suggestions (left suggested fixes for those). Clarified what happens to boards on multiuser switching edge cases, a typo here or there, and highlighted some api response docs
|
|
||
| **Response:** | ||
|
|
||
| ```json |
| ```json | ||
| { | ||
| "success": true | ||
| } | ||
| ``` |
There was a problem hiding this comment.
On success it returns a 204 No Content not a json with status. If there's an error the response is 422 with json:
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
There was a problem hiding this comment.
Thanks for picking that one up. Fixed.
| - `shared` -- read/write to the owner and administrator, read-only to everyone else | ||
| - `public` -- read/write by everyone | ||
|
|
||
| #### List One Boards |
There was a problem hiding this comment.
| #### List One Boards | |
| #### Get One Board |
Co-authored-by: Josh Corbett <joshwcorbett@icloud.com>
Co-authored-by: Josh Corbett <joshwcorbett@icloud.com>
…er' into lstein/docs/multiuser
Summary
This PR migrates the multiuser documentation from
docs-oldinto the new astrodocsdirectory. It also moves the Workflows section into Features, which seems to be a more appropriate place for it than at the top level.For convenience, this PR also updates the
make docsMakefile target.Related Issues / Discussions
QA Instructions
make docswill fire up astroFeaturessection.Merge Plan
Simple merge.
Checklist
What's Newcopy (if doing a release after this PR)