Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add ResStock Technical Reference Guide#1338

Merged
afontani merged 40 commits into
developfrom
trd
Jan 21, 2025
Merged

Add ResStock Technical Reference Guide#1338
afontani merged 40 commits into
developfrom
trd

Conversation

@afontani

@afontani afontani commented Jan 9, 2025

Copy link
Copy Markdown
Contributor

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.

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

- name: Save Docs
- name: Save technical development guide

Copy link
Copy Markdown
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
Copy Markdown
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

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