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

num_channels wording and updated github action to be able to view pdf/html as an artifact #319

Merged
merged 16 commits into from
Aug 29, 2024

Conversation

777arc
Copy link
Member

@777arc 777arc commented Aug 19, 2024

No description provided.

@777arc 777arc changed the title num_channels wording num_channels wording and updated github action to be able to view pdf/html as an artifact Aug 19, 2024
@777arc 777arc requested a review from jacobagilbert August 19, 2024 16:33
@777arc
Copy link
Member Author

777arc commented Aug 19, 2024

You can preview the new docs under GitHub's "Actions" menu at the top, click the run that corresponds to your PR, scroll down to "Artifacts", download the artifact named "out", unzip it, and you should be able to see the html and pdf. Maybe one day I'll make it so that it publishes the html/pdf at https://sigmf.org/pr-name/ so that you just click a link to immediately preview things.

additional_content.md Outdated Show resolved Hide resolved
additional_content.md Outdated Show resolved Hide resolved
@777arc
Copy link
Member Author

777arc commented Aug 20, 2024

@jacobagilbert I think I addressed the suggestions but go ahead and edit it directly if you want to make any tweaks, here's a direct link to editing that line of my branch - https://github.com/sigmf/SigMF/edit/777arc-patch-1/additional_content.md?#L165

Copy link
Collaborator

@Teque5 Teque5 left a comment

Choose a reason for hiding this comment

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

At a minimum rename that zip file per my code comment. Without pandoc the zip is 1MB vs 125MB. I believe you can use wildcards to select the files you want.

Note that actions/upload-artifact@v3 is being deprecated for v4 per here.

.github/workflows/generate_docs_pr.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
sigmf-schema.json Show resolved Hide resolved
@777arc 777arc merged commit 079cbb4 into main Aug 29, 2024
1 check passed
@777arc 777arc deleted the 777arc-patch-1 branch August 29, 2024 03:47
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