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.

Sign up for GitHub

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

Jump to bottom

Create Client Doc Spec #7

Closed

dcramer opened this issue Jul 20, 2015 · 4 comments

Member

dcramer commented Jul 20, 2015

A description of what client docs should look like (rough layout) and requirements.

Some examples:

Main page should contain install, config, and general usage
Frameworks should each be a dedicated page
General TOC guidelines
To be included, repo must be under the getsentry org on GitHub

dcramer mentioned this issue

Simplify Integration / Language Docs #8

Closed

Member

mitsuhiko commented Jul 20, 2015

We also need to make sure clients start defining the wizard configurations which is currently missing in all clients but the Python one.

Member Author

dcramer commented Jul 21, 2015

Here's how I'm thinking about it:

Integration

Getting Started (Install, basic config, basic usage) -- this is the index page
Configuration
... Frameworks
... Other

Getting Started (index.rst)

Install
Basic configuration
- DSN
- Release parameter
Capture Exception
User and tags context

Contributor

cameronmcefee commented Sep 4, 2018

Can we close this with the new docs that are on the way?

Contributor

PeloWriter commented Dec 22, 2020

We have this issue resolved now, I believe (see https://docs.sentry.io/contributing/approach/write-sdk-docs/).

PeloWriter closed this as completed

github-actions bot locked and limited conversation to collaborators

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