Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Put the API spec in its own repo #300

Open
bates64 opened this issue Mar 8, 2018 · 5 comments
Open

Put the API spec in its own repo #300

bates64 opened this issue Mar 8, 2018 · 5 comments
Assignees
Labels
meta Related to this repo, not the code. wip Work-in-progress.

Comments

@bates64
Copy link
Collaborator

bates64 commented Mar 8, 2018

No description provided.

@towerofnix
Copy link
Member

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.

@towerofnix towerofnix added discuss We should discuss this. meta Related to this repo, not the code. labels Mar 8, 2018
@bates64
Copy link
Collaborator Author

bates64 commented Mar 9, 2018

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
Copy link
Member

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

@towerofnix towerofnix removed the discuss We should discuss this. label Mar 9, 2018
@bates64 bates64 added the wip Work-in-progress. label Mar 12, 2018
@bates64 bates64 self-assigned this Mar 12, 2018
@bates64
Copy link
Collaborator Author

bates64 commented Mar 12, 2018

This is done.

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

@bates64
Copy link
Collaborator Author

bates64 commented Mar 13, 2018

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Related to this repo, not the code. wip Work-in-progress.
Projects
None yet
Development

No branches or pull requests

2 participants