WIP Add readme on API #33
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ai
reviewed
Sep 8, 2023
|
|
||
| const astroTypedoc = await initAstroTypedoc({ | ||
| baseUrl: '/docs/', | ||
| entryPoints: [resolve(__dirname, 'path/to/entry/point.ts')], |
There was a problem hiding this comment.
path/to/entry/ → my-library/index.ts
Maybe we should add // Add path to your library here
ai
reviewed
Sep 8, 2023
|
|
||
| ### `initAstroTypedoc({ baseUrl, entryPoints, tsconfig })` | ||
|
|
||
| Creates `astroTypedoc` instance. Accepts config object as a parameter. |
There was a problem hiding this comment.
It is not clear what is astroTypedoc instance and how it can be useful for me as a user.
Something like this could be better:
Creates a builder of pages and side-menu for your TypeDoc
ai
reviewed
Sep 8, 2023
|
|
||
| Path to `tsconfig.json` of the project, which code will be documented. | ||
|
|
||
| ### `astroTypedoc.getReflections` |
There was a problem hiding this comment.
It is not clear how I can use this method.
ai
reviewed
Sep 8, 2023
|
|
||
| await astroTypedoc.generateDocs(typedocProject, 'src/pages/docs') | ||
| await astroTypedoc.generateNavigationJSON( | ||
| reflections, |
There was a problem hiding this comment.
I can’t find this variable definition
ai
reviewed
Sep 8, 2023
|
|
||
| Project reflection contains information about types and serves as the basis for creating documentation. | ||
|
|
||
| ### `astroTypedoc.generateDocs(typedocProject, outputFolder)` |
There was a problem hiding this comment.
Suggested change
| ### `astroTypedoc.generateDocs(typedocProject, outputFolder)` | |
| ### `astroTypedoc.generateDocs(reflections, outputFolder)` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.