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

Documentation that makes you feel like you never left your editor (23) 5.8.2019 #42

Open
agraebe opened this issue Jul 28, 2019 · 2 comments
Assignees
Labels
Accepted This topics has been selected for future posts

Comments

@agraebe
Copy link
Collaborator

agraebe commented Jul 28, 2019

Description

I'm in awe when I experience documentation that feels so familiar. Like I never left my editor. A great example is Stripe: https://stripe.com/docs/api

If you just start searching (simply hit '/'), you will know what I mean:

Screen Shot 2019-07-27 at 6 17 20 PM

I would love to discuss how current dev platforms make developers feel like they're home. In their own editor or CLI.

Readers should learn about most recent trends on documentation UX.

@agraebe agraebe added the Topic-idea Idea for 100DaysDX site posting label Jul 28, 2019
@kyyberi kyyberi added Accepted This topics has been selected for future posts and removed Topic-idea Idea for 100DaysDX site posting labels Jul 28, 2019
@kyyberi
Copy link
Owner

kyyberi commented Jul 28, 2019

@agraebe How do you feel if this would go out Aug 5th? Then the branch would be "feature/day23".

@agraebe agraebe self-assigned this Jul 28, 2019
@agraebe
Copy link
Collaborator Author

agraebe commented Jul 28, 2019

Let’s do it!

@kyyberi kyyberi changed the title Documentation that makes you feel like you never left your editor Documentation that makes you feel like you never left your editor (23) Jul 30, 2019
@kyyberi kyyberi changed the title Documentation that makes you feel like you never left your editor (23) Documentation that makes you feel like you never left your editor (23) 5.8.2019 Jul 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted This topics has been selected for future posts
Projects
None yet
Development

No branches or pull requests

2 participants