shockrah
3cf77300b6
+ Readme
...
* Fixing message field name to reflect its actualy key name
type -> content_type
2021-08-28 14:23:27 -07:00
shockrah
fcd48a36a1
+ More comprehensive overview section
2021-07-05 17:07:41 -07:00
shockrah
a69ad24a45
+ Badge structure docs
...
Also this is a new pattern but I'm going to start actually using those anchor tags
to self link to other places in the page.
+ /badge/new endpoint docs
+ /badge/delete endpoint docs
+ /badge/update/name endpoint docs
+ /badge/update/color endpoint docs
+ /badge/update/perms endpoint docs
! Small point but apparantly this layout is somewhat printer friendly
:^) Just thought that was kinda neat.
2021-07-01 21:09:26 -07:00
shockrah
aed1737782
+ Docs for badge rtc events
...
Describes what kind of data to expect from RTC events
+ Meta docs around conventions in badge docs section
2021-06-14 21:38:56 -07:00
shockrah
55c2e6d960
Merge branch 'wiki' of gitlab.com:shockrah/freechat into wiki
2021-06-14 19:02:33 -07:00
shockrah
7ae975e7c1
! Finsihed goal on roadmap
...
! Finished docs on new update from roadmap
/neighbors/ api is now fully doc'd however we still need some rtc integration
2021-05-12 15:00:39 -07:00
shockrah
39ae3ba6be
Adding example of websocket url
2021-04-14 22:39:06 -07:00
shockrah
0b0bcd5de6
First pass docs for rtc capabilities
2021-04-14 22:38:43 -07:00
shockrah
291505201b
removng fluff and adding link to repo
2021-03-24 15:19:43 -07:00
shockrah
92dc4d888f
meta tags and favicon
2021-03-22 22:39:51 -07:00
shockrah
3ee22ff932
- Removed remaining mentions of joindate
2021-03-20 22:54:00 -07:00
shockrah
975acfd606
Backend REST API changes:
...
* Fixed weird match with get_online_members
+ Now using special(smoll) Public Member struct for public member data fetches as.
They're size on networks should be pretty small so we can package a ton of them in a single request
DOCS changes:
- Removing references to unix timestamps in seconds
- Removing references to joindate
* Exact content-type values now specified
2021-03-20 22:44:22 -07:00
shockrah
cf1dee9842
➕ New docs describing new /members/single route
2021-03-05 19:26:11 -08:00
shockrah
ba7b33ae62
✨ Fixed broken links for messages endpoint description
...
❗ Should probably have a section for messages under structures
2021-03-04 13:21:09 -08:00
shockrah
bc19f220fa
More docs on what to expect from the protocol and freechat servers/clients in general
2021-02-23 22:15:58 -08:00
shockrah
6ab622d109
adding first pass of overview section
2021-02-23 21:44:26 -08:00
shockrah
c896870397
Reformatting of wiki:
...
* Adding endpoint docs and correcting some typesetting mistakes
* Change qs params to match documentation
* Splitting up articles to geneate the sidebar links properly'
* Bad baseurl issue fixed in previous patch
2021-02-18 16:29:29 -08:00
shockrah
fbf4880d46
Starting content to test deployment
2021-02-13 18:14:42 -08:00
shockrah
4b346c60e6
Starting content to test deployment
2021-02-13 17:14:41 -08:00
shockrah
cf490419a2
Submodule for wiki theme
2021-02-13 16:58:09 -08:00
shockrah
e693d7e62b
Removing docs which are soon to be replaced by a proper wiki page
2021-02-11 22:25:52 -08:00
shockrah
5b63f0113b
more accurate api docs to meet with what is currently supported
2020-11-18 16:42:45 -08:00
shockrah
ea2cccb024
note regarding badges ready for actual badges notes
2020-05-26 02:40:29 -07:00
shockrah
d3bcb5a623
more formatting fixes
2020-05-25 14:00:15 -07:00
shockrah
bcff4f02a7
updated bullet point formatting as gitlab clobbered newlines
2020-05-25 13:51:47 -07:00
shockrahwow
edca7b3a4a
new docs builder script to be used by the docker container later
2020-05-25 13:41:03 -07:00
shockrahwow
0cddfc3289
structures section now in its own page
2020-05-25 13:40:19 -07:00
shockrahwow
e945897ac1
removed old outdated docs
2020-05-25 13:39:49 -07:00
shockrahwow
ec25992578
moved structures secction to its own .md + sub sectioned everything to fit into a greater sub context in the full docs
2020-05-25 13:38:24 -07:00
shockrah
b29f9d6934
api::auth route parameters have updated notes regarding types
2020-05-25 13:16:58 -07:00
shockrah
04ca53dc79
new docs for the updated api requirements
2020-05-05 21:56:39 -07:00
shockrah
1cab9b8bb8
note in api regarding purpose of doc
2020-04-25 18:33:16 -07:00
shockrahwow
6e9c485d69
notes about what the client should expect from the api for now
2020-04-17 17:13:42 -07:00
shockrah
670d2ddf5d
todo things
2019-12-15 16:25:00 -08:00