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

Dev #95

Merged
merged 3 commits into from
Nov 25, 2023
Merged

Dev #95

merged 3 commits into from
Nov 25, 2023

Conversation

prjctimg
Copy link
Owner

@prjctimg prjctimg commented Nov 25, 2023

PR deals with the documentation automation documentation automation

Run npm run docs to see the output in the docs folder and preview it in your code editor.

What's next?

  • Remove redundant information from the typedoc injection.
  • Add support for links to source code
  • Add the workflow file for deploying the docs.

So the next challenge is to find a way to push these changes to the documentation site automatically triggering a rebuild of the site.

Please let me know if this can be improved

@foss2cyber @takanome-dev @adarshswaminath

…to inject typedoc results into template files. Still working out some kinks and removing redundant information
@foss2cyber foss2cyber merged commit cd76bdc into main Nov 25, 2023
2 checks passed
@foss2cyber foss2cyber deleted the dev branch November 25, 2023 13:22
Copy link
Collaborator

@adarshswaminath adarshswaminath left a comment

Choose a reason for hiding this comment

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

Approved

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.

3 participants