Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(topics): add runtime config doc #201

Closed
wants to merge 1 commit into from

Conversation

vdice
Copy link
Contributor

@vdice vdice commented Jul 16, 2024

Adds a Runtime Configuration topic guide.

Closes #199

@bacongobbler
Copy link
Contributor

bacongobbler commented Jul 17, 2024

The content here looks great! However, I do wonder if it might make sense to break this document into separate topic guides:

  • Handling application secrets
  • Connecting to a SQL database
  • Using a key/value store
  • Using AI in your application

This gives the user the ability to search for a specific topic that would apply to their app. We can then use it as a "springboard" to discuss how to apply these topics to their application, including any trade-offs, examples, or alternative solutions.

If we wanted to document the specific schema of the runtime config, I might suggest placing that documentation under the reference guides. That would be a great place to put it - IMO most readers won't care about the runtime config schema moreso than the abilities it provides. That is, I believe they'd care more about how to add capability X to their application.

What do you think of this approach?

@bacongobbler
Copy link
Contributor

bacongobbler commented Jul 17, 2024

@vdice
Copy link
Contributor Author

vdice commented Jul 17, 2024

Thank you @bacongobbler, your vision for separate topic guides and then linking to the runtimeconfig spec reference where appropriate definitely seems the more helpful and reader-friendly way to go. On it! Will close those this PR but pull relevant bits into forthcoming topic guide PRs.

@vdice vdice closed this Jul 17, 2024
@vdice vdice mentioned this pull request Jul 17, 2024
4 tasks
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.

Add runtime config docs
2 participants