search

decent-chat / decent

Open source messaging platform for the modern web
https://meta.decent.chat
GNU General Public License v3.0
21 stars 5 forks source link

Put the API spec in its own repo #300

Open bates64 opened 6 years ago

towerofnix commented 6 years ago

Why? Whenever we make changes to the API implementation, it's important to update the documentation at the same time. Thus keeping the API specification and implementation in the same repository lets pull requests modify both in one go, and this is convenient.

bates64 commented 6 years ago

I'm thinking we update the spec in advance of the implementation written here, mainly to give server/client authors to update their software to comply with the changes to the spec (entirely backwards compatible provided we don't bump the major ver).

We can also then have issues for specific ideas of things that are less tightly coupled to the implementations here, think RFCs, proposals, etc. Separating implementation from spec could be a great idea.

Oh, and we can use github releases for the changelog of the spec itself and here (+ npm) for releases of decent.js/server/client eg. deprecating something in decent.js shouldn't be of the same importance as a spec change.

towerofnix commented 6 years ago

@heyitsmeuralex Cool, thanks for explaining! Those sound like good reasons to me.

bates64 commented 6 years ago

This is done.

Only thing left is to remove docs/api.md (and probably docs/why.md also, since it's a joke).

bates64 commented 6 years ago

Also we should probably update the README.md here to better reflect the new description of Decent like in the spec (Open source messaging platform for the modern web etc etc).

Oh, and move some proposals over (#286, reactions)