Hemanth V. Alluri
f280e9cf84
lib: Rename lib/api_test_helpers.py to openapi/python_examples.py
...
This will make the contained code easier to find.
2019-08-05 21:06:19 -07:00
Hemanth V. Alluri
c90056bdb2
tools: Move check-swagger to check-openapi and make it executable.
2019-08-05 21:06:19 -07:00
David Rosa
871fd57f5e
docs: Fix minor issues in api.md.
...
With some tweaks for greater clarity by tabbott.
2019-07-22 12:07:50 -07:00
Rishi Gupta
7afb44987e
docs: Update tips for writing user documentation.
2019-07-20 14:39:15 -07:00
Tim Abbott
c931e76cf2
docs: Rewrite docs on writing API documentation.
...
This had gotten badly out of date, since it wasn't updated when we did
the big migration to the OpenAPI documentation system.
Fixes part of #12571 .
2019-07-19 18:00:01 -07:00
Rafid Aslam
b52a7aed07
docs: Move tutorials/documenting-api-endpoints to documentation/api.
...
Move docs/tutorials/documenting-api-endpoint.md to
docs/documentation/api.md.
This makes it easier to find when browsing the complete set of
materials on writing Zulip documentation.
2019-05-30 11:12:25 -07:00
Tim Abbott
b13add3eaf
docs: Add missing index.rst for documentation/.
...
Apparently I failed to commit this part of our documentation
migration.
2019-05-29 17:54:02 -07:00
Tim Abbott
0330a5ed82
docs: Use bulleted list for user-facing subsystems.
...
This makes it a bit more visually obvious that there are more than 3
total things expected below.
2019-05-29 15:52:18 -07:00
Tim Abbott
fa37c5cee1
docs: Extract a Writing Documentation top-level section.
...
This should make this easier to find, and also makes "Subsystems" a
bit smaller of a catch-all.
2019-05-29 15:52:11 -07:00