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

Generate docs from schema #1133

Closed
domoritz opened this issue Feb 17, 2016 · 4 comments
Closed

Generate docs from schema #1133

domoritz opened this issue Feb 17, 2016 · 4 comments

Comments

@domoritz
Copy link
Member

The process could look as follows:

  • Generate json schema from typescript with comments
  • A script takes the json schema and creates a file in _includes with a table just like the ones we have in the docs for each defined object.
  • We manually include the tables in the docs with {% include bin_properties.md %}
@kanitw
Copy link
Member

kanitw commented Feb 17, 2016

The description here is NOT as completed as what we discussed in person.

We need to be able to specify which properties we want in each table. For example, axis.md nicely group axis properties into multiple tables although all of them are properties of Axis object.

@kanitw
Copy link
Member

kanitw commented Feb 17, 2016

Actually, another thing to consider is that currently in the table, sometimes to highlight code using backtick.

Maybe when copying description to the TS file, we might need to convert the backtick to html so that the tables stay the same. (Or find a way to parse the comment in TS as markdown, but I'd say converting to html would be much simpler.)

@domoritz
Copy link
Member Author

As an alternative, we could simply not do this and only have very brief descriptions in the code and not bother about keeping the code and docs automatically in sync. I think I actually prefer that.

@kanitw
Copy link
Member

kanitw commented Feb 17, 2016

Yeah, given this complicated requirement, let's not do this.

@kanitw kanitw closed this as completed Feb 17, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants