Lumberjack Design Inputs Creation#1
Conversation
Initial commit to capture Requirements, Design, API, and related documentation.
volks73
added
documentation
volks73
left a comment
volks73
left a comment
There was a problem hiding this comment.
Great start. There appears to be some leftover files from a build that need to be removed. Some formatting changes where the markdown is word wrapped to 80 columns would improve source code readability (for me), too.
Thank you for the PR and moving forward with the project. Again, great start!
| ## Requirements | ||
|
|
||
| - LabVIEW 2014 or newer (native JSON and the Actor Framework). | ||
| - NI Actor Framework (the only runtime dependency). |
There was a problem hiding this comment.
Is there a specific NI package or VIP for the NI Actor Framework? I thought it was just an organization of LabVIEW classes, libraries, and projects.
There was a problem hiding this comment.
NI Actor Framework ships with every version of LabVIEW, so it should be covered by the LabVIEW dependency in the line above. I can clarify the documentation to indicate as much.
|
|
||
| - LabVIEW 2014 or newer (native JSON and the Actor Framework). | ||
| - NI Actor Framework (the only runtime dependency). | ||
| - Caraya, for the test suite only (not required at runtime). |
There was a problem hiding this comment.
Would it be possible to change "Caraya" to a link?
There was a problem hiding this comment.
Do you mean include a URL such as (https://www.jki.net/caraya)?
There was a problem hiding this comment.
Maybe this one: https://www.vipm.io/package/jki_lib_caraya/
|
|
||
| ## Quick start | ||
|
|
||
| Singleton style, three nodes: |
There was a problem hiding this comment.
Once there is some implementation, a VI snippet/PNG for the Quick Start would be good.
There was a problem hiding this comment.
Adding a @todo in the documentation so I don't forget..
…rol files Removed .docx files, added @todo items to API Guide and README files to incorporate snippet/PNG when ready, fixed .gitignore file to uncomment *.docx and *.pdf file types, removed files,zip
Scripts folder changed to "scripts" in section 8.2 of the Design Document.
Some markdown documents did not get updated correctly, so having to re-commit all documents to ensure all updates are included.
Document updates required to clean up missed changes in PascalCase use, space removal, and folder naming.
volks73
left a comment
volks73
left a comment
There was a problem hiding this comment.
Great progress. Keep it up.
A possible extra file/directory to remove, and then this PR will be ready to approve and merge.
There was a problem hiding this comment.
I think the .Lumberjack.UserState directory should be added to the .gitignore, too.
…ore updates Still trying to get Claude generated documentation cleaned up and prevent content regressing. Hopefully this is getting more stable.
2 participants
This is an initial commit with requirements and design content.
I suspect this content will evlove once I start actually creating LabVIEW code, so this is also a test to make sure I'm working properly within the GitHub project.