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

RFC: Transform "Common Questions" to a "Recipes" page in the docs #815

Closed
kitten opened this issue May 15, 2020 · 1 comment
Closed

RFC: Transform "Common Questions" to a "Recipes" page in the docs #815

kitten opened this issue May 15, 2020 · 1 comment
Labels
documentation 📖 This needs to be documented but won't need code changes future 🔮 An enhancement or feature proposal that will be addressed after the next release

Comments

@kitten
Copy link
Member

kitten commented May 15, 2020

Summary

The current "Common Questions" page in the docs is a little low on content, but we do have content that needs to be written up. What they all have in common is that they're frequently "exchange patterns" and code snippets that we have that a user would pick up and customise for things that are very custom.

Proposed Solution

We can rename "Common Questions" to "Recipes" and port some content over.

Furthermore, it'd be great to 1) keep the titles on that page shorter to make it more searchable, and 2) to maybe add summary+details spoilers if it becomes too long (?)

Requirements

  • Rename "Common Questions" to "Recipes"
  • Ensure that the recipe is not too specific (it should be highlighted that the code is a pattern, but will only vaguely reflect what the user must do, e.g. "Insert your X logic here/there") but must be descriptive enough to allow initial copy&pasting
  • Add "Authentication" recipe
  • Add "Global Error Handling" recipe
@kitten kitten added future 🔮 An enhancement or feature proposal that will be addressed after the next release documentation 📖 This needs to be documented but won't need code changes labels May 15, 2020
@kitten
Copy link
Member Author

kitten commented Sep 15, 2020

I think we sufficiently cover this now and don't need new sections in the docs momentarily

@kitten kitten closed this as completed Sep 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 This needs to be documented but won't need code changes future 🔮 An enhancement or feature proposal that will be addressed after the next release
Projects
None yet
Development

No branches or pull requests

1 participant