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

JavaScript Documentation #367

Merged
merged 4 commits into from
Feb 27, 2023
Merged

JavaScript Documentation #367

merged 4 commits into from
Feb 27, 2023

Conversation

pnmadelaine
Copy link
Contributor

This PR updates the gh-pages workflow to also build the JS documentation.
It also updates the JS page in the mdbook.
Fixes #366

@pnmadelaine pnmadelaine requested a review from a team as a code owner February 27, 2023 10:53
@cla-bot cla-bot bot added the cla-signed label Feb 27, 2023
@coveralls
Copy link

coveralls commented Feb 27, 2023 •
edited
Loading

Pull Request Test Coverage Report for Build 4283221817

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 53.441%
Totals Coverage Status
Change from base Build 4252436588: 0.0%
Covered Lines: 30398
Relevant Lines: 56881
💛 - Coveralls

duesee
duesee reviewed Feb 27, 2023
View reviewed changes
Copy link
Contributor

@duesee duesee left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the PR and the extra documentation! I tried to follow along but am not sure if this works because I get a warning and it seems there is no documentation entry generated. (Edit: Will try to resolve because I think it was an issue with my npm installation.)

It would be great to have a mach parameter to build the JavaScript documentation similar to https://github.com/cryspen/hacl-packages/blob/main/tools/doc.py#L47. Normally, I would have suggested to land this first and to file an issue to add the mach doc --javascript command later. But given that I am not sure how to test this, maybe it makes sense to do it already? What do you think?

docs/book/src/hacl-js/readme.md Outdated Show resolved Hide resolved
js/doc/.gitignore Show resolved Hide resolved
docs/book/src/hacl-js/readme.md Outdated Show resolved Hide resolved
docs/book/src/hacl-js/readme.md Show resolved Hide resolved
docs/book/src/hacl-js/readme.md Outdated Show resolved Hide resolved
@duesee
Copy link
Contributor

duesee commented Feb 27, 2023 •
edited
Loading

Okay, I got it working 👍 So, I'm fine with either getting this in (after the conversations are resolved) or adding mach doc --javascript already. Could you also link to the JavaScript documentation in the front page already? Here docs/book/src/readme.md:18??

duesee
duesee approved these changes Feb 27, 2023
View reviewed changes
Copy link
Contributor

@duesee duesee left a comment

Choose a reason for hiding this comment

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

Thanks! With the last conversation closed this is good to go. I think it would be best to squash.

@duesee duesee merged commit 56176d6 into main Feb 27, 2023
@duesee duesee deleted the pnmadelaine-js branch February 27, 2023 14:48
@pnmadelaine pnmadelaine mentioned this pull request Feb 27, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@duesee duesee duesee approved these changes

@franziskuskiefer franziskuskiefer Awaiting requested review from franziskuskiefer

Assignees
No one assigned
Labels
cla-signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

JavaScript Documentation
3 participants
@pnmadelaine @coveralls @duesee