Skip to content

docs: Update configuration docs to redirect to module configuration#387

Open
exaby73 wants to merge 1 commit into
serverpod:mainfrom
exaby73:feat/clean-up-config-docs
Open

docs: Update configuration docs to redirect to module configuration#387
exaby73 wants to merge 1 commit into
serverpod:mainfrom
exaby73:feat/clean-up-config-docs

Conversation

@exaby73

@exaby73 exaby73 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

@marcelomendoncasoares marcelomendoncasoares left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Only one minor question for clarification!

Comment on lines +322 to +328
serverpod_auth_idp:
nickname: auth
my_custom_module:
nickname: custom
```

This allows you to reference module classes as `module:auth:UserInfo` in your model files. See the [modules documentation](modules) for more information.
This allows you to reference module classes as `module:auth:AuthUser` in your model files. See the [modules documentation](modules) for more information.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Question: Will this work? Since AuthUser is declared under serverpod_auth_core, but exported from serverpod_auth_idp.

If this is true, we should also update the reference in the authentication docs to use module:serverpod_auth_idp:AuthUser and fix serverpod/serverpod#4492.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Above a nickname is given so it's pointing to serverpod_auth_idp

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We should change the module referenced here to core, right? Since we already saw that it won't work due to the serverpod_auth_core models being exported in the serverpod_auth_ipd_server/core.dart. Unless we add the export to both the client and server central export file for the IDP package. What do you think?

@developerjamiu

Copy link
Copy Markdown
Contributor

Two things blocking this from progressing:

  1. Marcelo's follow-up question on Jan 9 about whether module:auth:AuthUser actually resolves (since AuthUser is declared in serverpod_auth_core and not exported from serverpod_auth_idp) is still unanswered. He proposed two paths: change the module reference to core, or add the export to the IDP package's central export file. Could you confirm which way the framework team wants to go and update accordingly?
  2. The branch has merge conflicts with main. A rebase will be needed before this can land.

Happy to give it another pass once both are sorted.

Comment on lines +91 to +92
- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads)
- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets)

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.

Suggestion: two small adjustments to the bullet. The file-uploads page also documents Cloudflare R2, so naming it makes the pointer accurate. Matching the link text to the actual heading on the auth page ("Storing Secrets") reads more cleanly than "Authentication Setup".

Suggested change
- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads)
- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets)
- **Cloud storage**: see [Uploading files](file-uploads) for GCP, AWS S3, and Cloudflare R2 secrets.
- **Authentication**: see [Storing secrets](authentication/setup#storing-secrets) on the Authentication setup page.

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.

module documentation is inaccurate

3 participants