Skip to content
This repository has been archived by the owner on Aug 25, 2024. It is now read-only.

Add API docs to Logux website #23

Open
ai opened this issue Apr 16, 2020 · 3 comments
Open

Add API docs to Logux website #23

ai opened this issue Apr 16, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ai
Copy link
Member

ai commented Apr 16, 2020

We need an API doc like we have for Node.js.

I will like to have the same design for API docs across all languages. So we will need to write a custom HTML generator. It is hard, but I will do most of the work.

I need a help only to:

  1. Create a Make task to generate a JSON file of API.
  2. Give me a set of commands from git clone to get that JSON file of API.
@ai ai assigned ai and egregors Apr 16, 2020
@ai ai added the documentation Improvements or additions to documentation label Apr 16, 2020
@egregors
Copy link
Member

@ai So, you wanna all Logux integration projects have smth like make docs witch generate one JSON file will full API description? Do we talk about auto-gen documentation?
Where I can find the schema of JSON objects you will expect?

@ai
Copy link
Member Author

ai commented Apr 20, 2020

So, you wanna all Logux integration projects have smth like make docs witch generate one JSON file will full API description?

Every project will generate own file with JSON (and they can use different schema). Then by JS converter, I will convert it to the same HTML.

Here is how I do it for TypeDoc (I use JS object instead of JSON in the case of TypeScript):

  1. Call TypeDoc built-in tool to get objects with API docs
  2. Convert these objects to HTML

Where I can find the schema of JSON objects you will expect?

I will write a convertor from any JSON schema.

Something like

@egregors
Copy link
Member

egregors commented Oct 2, 2020

rel logux/logux.org#22

Make sure make docs works properly from the ENV

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

No branches or pull requests

2 participants