search

writethedocs / www

The main website for Write the Docs.
http://www.writethedocs.org
Other
1.32k stars 511 forks source link

API content is outdated #2171

Open stumblefiend opened 2 months ago

stumblefiend commented 2 months ago

For specifics on what is outdated, see https://github.com/writethedocs/www/pull/2169#issuecomment-2216780424

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

plaindocs commented 2 months ago

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.