search

4chan / 4chan-API

Documentation for 4chan's read-only JSON API.
http://www.4chan.org/
1.03k stars 74 forks source link

Refactor documentation #69

Closed cyggy closed 5 years ago

cyggy commented 5 years ago

This is a proposed refactor of the API documentation. Some of the formatting has been cleaned up and each route was given its own page, boards.json and its attributes were also documented.

If anyone has feedback, if you like/hate the changes, have recommendations, plz chime in. It still needs to be proofread for spelling errors and other dumb mistakes.

AGSPhoenix commented 5 years ago

The m_img attribute discussed in #63 is not mentioned.

cyggy commented 5 years ago

Ready for review @desuwa

dcdholder commented 5 years ago

Nice work on this.

Check #71 and #45 for info on last_modified (it's updated on thread/post edit events, as well as additions and deletions). last_modified should also not have a row in Threads.md, and it's not in the example output.

cyggy commented 5 years ago

@dcdholder thanks! removed last_modified from Threads.md

saxamaphone69 commented 5 years ago

Nice work, @cyggy

catamphetamine commented 5 years ago

@cyggy Oh wow, this is now better than my reverse-engineered docs