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

Documentation data #17

Open
jonschlinkert opened this issue Aug 2, 2013 · 1 comment
Open

Documentation data #17

jonschlinkert opened this issue Aug 2, 2013 · 1 comment
Labels

Comments

@jonschlinkert
Copy link
Contributor

One of my "design" goals for the new site is to look for opportunities to make data more reusable, whenever possible. For example, our CHANGELOG will be formatted as YAML so that it can be parsed and used in templates. This allows the changelog to be rendered as markdown, HTML, or even pulled down from the GitHub API and consumed by some other application or lib.

I also believe that - if executed well - this will make the site more accessible, scalable and maintainable.

  • changelog: version (object|key), date (string), changes (associative array)
  • language features (todo)

Related

@jonschlinkert
Copy link
Contributor Author

@matthew-dean, your thoughts on this would be great.

Also, you mentioned a "docs API", I think this will definitely be achievable in short order. GitHub's api let's you pull down specific documents (.e.g. '/repos/less/less-docs/contents/features.json' or whatever), you just need to set the encoding (probably to utf8) and you're good to go.

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

No branches or pull requests

1 participant