Slate: Add API Reference for 0.5x+

Created on 3 Feb 2020  Â·  4Comments  Â·  Source: ianstormtaylor/slate

The lack of API Reference for 0.5x+ is a critical hole in Slate.

There is conversation about using inline comments to generate documentation; however, I think as an interim step, it would be a benefit to the community if somebody manually created the documentation.

I am posting this (a) to put the request out to the community for help and (b) perhaps through reactions gauge how important this is to others.

docs ♥ help

Most helpful comment

Merged in a generous PR that adds manually written API documentation. Long term, I think it's still a goal to have auto generated documentation, but this has been more challenging than originally anticipated.

Closing this issue. If you guys find any issues with the documentation, please submit a PR to fix mistakes.

All 4 comments

I was hoping to migrate a project over, but I'm new to Slate and I'm finding the lack of API References to be quite a big road block. Would love to see this.

I also agree, I would help myself but I'm also new to Slate. I'm having a hard time understanding the API without a reference. I'm spending more time in Slate's than in my own, just trying to figure out how to accomplish basic stuff.

Agreed! I've just found myself reading the Slate source (and looking at the examples), and took about a month of migrating from 0.47 to become familiar with the different parts of the source

Merged in a generous PR that adds manually written API documentation. Long term, I think it's still a goal to have auto generated documentation, but this has been more challenging than originally anticipated.

Closing this issue. If you guys find any issues with the documentation, please submit a PR to fix mistakes.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

YurkaninRyan picture YurkaninRyan  Â·  3Comments

AlexeiAndreev picture AlexeiAndreev  Â·  3Comments

bengotow picture bengotow  Â·  3Comments

chrpeter picture chrpeter  Â·  3Comments

ianstormtaylor picture ianstormtaylor  Â·  3Comments