Skip to content
This repository has been archived by the owner on Apr 29, 2020. It is now read-only.

Arrange groupings semantically and not alphabetically #22

Closed
RichardLitt opened this issue Jan 12, 2016 · 5 comments
Closed

Arrange groupings semantically and not alphabetically #22

RichardLitt opened this issue Jan 12, 2016 · 5 comments
Assignees

Comments

@RichardLitt
Copy link
Contributor

What

@diasdavid:

@RichardLitt can we break the apiary API docs description using the same categories found on https://github.com/ipfs/specs/blob/ipfs/api/api/core/README.md ?

The suggestion is that we should have Network, Tooling, Extensions, and Core sections, and list each method in each section appropriately, instead of the alphabetical grab-bag we currently have.

Response

I'm not sure. I think that keeping it as it currently is OK. I also don't see a way in the apiary docs to do this easily. I think we should look into this again, after we have the API stubbed out.

@RichardLitt RichardLitt changed the title Arrange Arrange groupings semantically and not alphabetically Jan 12, 2016
@RichardLitt RichardLitt mentioned this issue Jan 12, 2016
5 tasks
@ralphtheninja
Copy link

The suggestion is that we should have Network, Tooling, Extensions, and Core sections, and list each method in each section appropriately, instead of the alphabetical grab-bag we currently have.

+1

@RichardLitt
Copy link
Contributor Author

@diasdavid How would you feel about a compromise, where I include a link to the spec for each command , and mention which group it is in in the description?

@RichardLitt
Copy link
Contributor Author

@diasdavid Thoughts?

@daviddias
Copy link
Contributor

daviddias commented Jun 28, 2016

Why do we need a compromise? Is there any technical limiting factor?

@RichardLitt
Copy link
Contributor Author

I don't know of a way to do that easily in Apiary - sections aren't a thing, I think? I could do # group tools or something.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants