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.

Sign up for GitHub

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

Jump to bottom

docs: Implement automatic site generation of package documentation. #6

Closed
wants to merge 4 commits into from
Closed

docs: Implement automatic site generation of package documentation. #6

wants to merge 4 commits into from

Conversation

jojobii-arks
Copy link

@jojobii-arks jojobii-arks commented Dec 20, 2022 •
edited

Linked Issues

Changes

  • Implement library documentation generation via TypeDoc, which utilizes the existing JSDoc (tsdoc) annotations.
    • Entry points are defined through exports within package.json.
  • Add a workflow to generate documentation and publish it to GitHub Pages via GitHub Actions for omo branch.

Notes

  • Since there are two separate exports within package.json for hs and keys for Node and Default, typedoc is unable to include it within documentation
  • For other pages such as usage manuals, @knodes/typedoc-plugin-pages is a possible solution.

Preview

CleanShot 2022-12-19 at 23 29 04@2x

CleanShot 2022-12-19 at 23 29 40@2x

CleanShot 2022-12-19 at 23 30 13@2x

jojobii-arks and others added 4 commits December 19, 2022 22:47
@jojobii-arks
Implement docs generation for GitHub Pages
51407ad 
* add gitignore for node_modules

* fix typo import

* implement typedoc site generation

* implement github action for pages deployment
@jojobii-arks
refine typedoc config
6b95cc3
@jojobii-arks
include version in typedoc
9b5d32a
@jojobii-arks
Merge branch 'omo' into omo
ce0874f
@randName
Copy link
Member

hi, thanks for the PR! I think it is definitely going to help once the library stabilizes, but with me moving things around it might not be the right time yet.

I'm keeping ActivityStreams & ActivityPub jsdoc comments to a bare minimum (just a link to the relevant spec) so it might not be that useful, but hs and keys are worth looking into since those are the actual modules with code.

Regarding the exports issue I see TypeStrong/typedoc#1937 and microsoft/TypeScript#50466 but I suspect there needs to be some manual twiddling with entryPoints. Ideally both browser & node gets documented.

@jojobii-arks
Copy link
Author

Sounds good! Feel free to close the PR; let me know if there's anything I can do as well 👍

@jojobii-arks
Copy link
Author

stale; closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Documentation generation via Typedoc
2 participants
@jojobii-arks @randName