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

chore: using typedoc to auto generate docs #347

Merged
merged 4 commits into from
Dec 21, 2022
Merged

chore: using typedoc to auto generate docs #347

merged 4 commits into from
Dec 21, 2022

Conversation

nicholasgriffintn
Copy link
Member

@nicholasgriffintn nicholasgriffintn commented Dec 21, 2022

In this PR, we are using the package typedoc to automatically generate documentation from our TypeScript files, which will allow us to:

  • Simplify the readme as currently everything has to go there and it can be hard to understand
  • Remove the requirement to manually update the documentation, outside of adding comments to your code
  • Adds more documentation within the code itself as this is how the docs are generated
  • Creates a homepage for sqs-consumer, where we could provide more information about functionality in the future

Changes

  • Added a workflow to automatically deploy the docs when deployed to main
  • Added the dependency typedoc to generate the docs
  • Added comments to the code to document the type definitions and functionality - basic
  • Cleaned up the README (hopefully https://bbc.github.io/sqs-consumer/ is our GitHub Pages domain)

@nicholasgriffintn nicholasgriffintn added this to the 6.2.0 milestone Dec 21, 2022
@nicholasgriffintn nicholasgriffintn merged commit 033110f into main Dec 21, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Dec 21, 2022
@nicholasgriffintn nicholasgriffintn deleted the typedoc branch February 15, 2023 23:08
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant