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

add typedoc-specific tsconfig #112

Merged
merged 3 commits into from
Aug 15, 2023
Merged

add typedoc-specific tsconfig #112

merged 3 commits into from
Aug 15, 2023

Conversation

sethvincent
Copy link
Contributor

@sethvincent sethvincent commented Aug 10, 2023

The only really interesting part about this is updating the package.json and adding a tsconfig.typedoc.json file: https://github.com/digidem/mapeo-schema/compare/fix-typedoc-tsconfig?expand=1#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519

Any improvements to the docs themselves that are being generated should be another issue/pr.

Closes #28

Copy link
Member

@gmaclennan gmaclennan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Small suggestion for tsconfig.

I'm wondering where it makes sense to include this in the build process? I noticed that the links that Typedoc generates under #### Defined In refer to s specific commit, so it seems like every time you run typedoc it changes the files.

Should we leave it the responsibility of the contributor to always re-build docs? Or run it as a commit hook? Or build on CI and push to a separate docs branch? or other?

tsconfig.typedoc.json Outdated Show resolved Hide resolved
Co-authored-by: Gregor MacLennan <gmaclennan@digital-democracy.org>
@sethvincent sethvincent requested a review from gmaclennan August 10, 2023 15:42
@gmaclennan
Copy link
Member

Since the generated docs are not useful at this time, and there is my unresolved question above about how we build docs and whether we commit them to main, I think it make sense to keep the docs folder ignored. Can you create a follow-up issue for what needs to be done for the docs to be useful?

@sethvincent sethvincent changed the title add typedoc-specific tsconfig, unignore docs directory add typedoc-specific tsconfig Aug 15, 2023
@sethvincent sethvincent merged commit 9f0350f into main Aug 15, 2023
@sethvincent sethvincent deleted the fix-typedoc-tsconfig branch August 15, 2023 16:11
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

Successfully merging this pull request may close these issues.

Revise how api docs are generated
2 participants