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

API content is outdated #2171

Open
stumblefiend opened this issue Jul 9, 2024 · 1 comment
Open

API content is outdated #2171

stumblefiend opened this issue Jul 9, 2024 · 1 comment

Comments

@stumblefiend
Copy link
Collaborator

For specifics on what is outdated, see #2169 (comment)

In general, we need a pillar page about Writing API Documentation and it could link to sub-pages / topics like

  • Introduction to APIs
  • Best Practices for API Documentation
  • Tools for API Documentation
@plaindocs
Copy link
Contributor

So this is 100% accurate, and is a product of the fact that nobody is (or has? @stumblefiend ) is really driving the Guide content. So someone once wrote about API Blueprint and that is now what we have.

I wonder if there is a world in which we could ask for volunteers to build out topics, in a similar way to the newsletter, but on a slower timeframe. It's a BIG ask though.

Running a writing day sprint, with a better idea of what we want is one way to go.

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

No branches or pull requests

2 participants