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

pi#2778 open report editor #1

Merged
merged 44 commits into from
Feb 10, 2025
Merged

pi#2778 open report editor #1

merged 44 commits into from
Feb 10, 2025

Conversation

gretacodes
Copy link
Collaborator

@gretacodes gretacodes commented Feb 6, 2025

  • all the files in docs/ directory are here temporarily until a proper solution is designed to deploy the documentation to Github Pages - this should ideally be a part of the CI. for the time being, the content from docs/ directory is automatically published to github pages. The documentation available is currently coming from 2778_open_report_editor branch but will be amended once this is merged in to main. The code existing in docs/ directory doesn't need to be reviewed as this is what gets generated by jsdoc lib.
  • minified library build will be available in the Releases section github. This will be published once this branch is merged in into main
  • documentation link - https://panintelligence.github.io/pi-embed-actions/
  • using jsdoc and clean-jsdoc-theme to generate documentation
  • using esbuild to make a minified js build
  • mocha and chai used for js unit testing

Copy link
Contributor

@neilmusgrove neilmusgrove left a comment

Choose a reason for hiding this comment

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

This looks really great, I've added a few comments mainly on the documentation side where I think we could improve clarity a little.

@neilmusgrove neilmusgrove merged commit f3ef30d into main Feb 10, 2025
9 checks passed
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.

2 participants