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

Add ResStock Technical Reference Guide #1338

Merged
merged 40 commits into from
Jan 21, 2025
Merged

Add ResStock Technical Reference Guide #1338

merged 40 commits into from
Jan 21, 2025

Conversation

afontani
Copy link
Contributor

@afontani afontani commented Jan 9, 2025

Pull Request Description

The Pull Request adds the ResStock Technical Reference Guide to the repository. The final PDF will be compiled and uploaded into the "documents" artifact.

This PR gets the document up and compiling on GitHub actions. At this point, I have not done a backlog since we started the documentation process.

There is also a lot of room for improvement in automation. The tex files probably contain copy/paste errors that can be automated.

Related Pull Requests

None

Related Issues

Checklist

Required:

Optional (not all items may apply):

@afontani afontani self-assigned this Jan 9, 2025
@afontani afontani marked this pull request as ready for review January 10, 2025 15:22
@afontani

This comment was marked as resolved.

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/workflows/config.yml Outdated Show resolved Hide resolved
docs/read_the_docs/source/changelog/changelog_dev.rst Outdated Show resolved Hide resolved
.github/workflows/config.yml Show resolved Hide resolved
@joseph-robertson joseph-robertson self-requested a review January 16, 2025 21:58

- name: Save Docs
- name: Save technical development guide
Copy link
Contributor

Choose a reason for hiding this comment

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

TDG gets built and uploaded as an artifact; it isn't committed to the repository.
TRG gets built and committed to the repository; it isn't uploaded as an artifact.

Should we be consistent here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah. I wanted the PDF initially, but the compiled TRG is 15MB. Uploading the TRG as an artifact: 6182fe9. Deleting the PDF from committed files: e20406b

@afontani afontani merged commit cb024c5 into develop Jan 21, 2025
7 checks passed
@afontani afontani deleted the trd branch January 21, 2025 18:39
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