API doc generation and doc format changes about api HOT 6 CLOSED

I like this a lot, especially the idea that I could generate a set of API documentation from the Atom source myself.

In the current documentation, there are bits and pieces from repositories other than atom/atom. Is it possible to decorate things in other official Atom repositories to be included in the official API documentation? For example: TextBuffer, Grammar, etc. What would that decoration look like?

from api.

I'm fine with whatever organization scheme you're excited about. The section headers seem nice and less redundant. Do we need the ### or would a simple # Section: Modifying Text be sufficient?

from api.

Any ideas for presenting the difference between essential and extended?

from api.

For example: TextBuffer, Grammar, etc. What would that decoration look like?

That will happen without decoration. It's automatic right now in biscotto.

Do we need the ### or would a simple # Section: Modifying Text be sufficient?

# Section: Modifying Text is probably sufficient. I do like the ### to visually break things up.

Any ideas for presenting the difference between essential and extended?

Not really yet. I need to sit down and think it through.

from api.

I like this a lot, especially the idea that I could generate a set of API documentation from the Atom source myself.

@lee-dohm with atom/atom#3126 that might become even easier. You might be able to do other interesting things with that json doc. It would likely make an atom docs package (docs inside atom as described in atom/atom#3123) really easy to write.

from api.

Closing this in favor of atom/atom#3126 and yet-to-be-created issue for doc mocks.

from api.