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

Documentation: What is the format? #163

Open
Meai opened this issue Jun 13, 2015 · 3 comments
Open

Documentation: What is the format? #163

Meai opened this issue Jun 13, 2015 · 3 comments
Assignees
Labels

Comments

@Meai
Copy link

Meai commented Jun 13, 2015

At the end of the day srclib is a format right? Yet from the website and readme, the actual format is nowhere to be seen.
It's like making json but not actually showing what json looks like.

@MaikuMori
Copy link
Contributor

The format can still change, here's some information.

Another option is to look at the structs in the source. Here are some:

Srclib team is currently working on autogenerated documentation from source, but the work is not yet done as far as I know. The source itself is quite well documented.

@sqs
Copy link
Member

sqs commented Jun 13, 2015

I agree: the format should be easy to get to from the homepage. Right now you have to click on Docs, then Schema, then one of the items.

@jelmerdereus jelmerdereus self-assigned this Jun 15, 2015
@jelmerdereus
Copy link
Contributor

@Meai thanks for your feedback. It's on the wish list already and it will be addressed.

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

No branches or pull requests

4 participants