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

handle all outstanding @todo annotations in Lando model #40

Open
6 tasks done
kiniry opened this issue Dec 18, 2021 · 3 comments
Open
6 tasks done

handle all outstanding @todo annotations in Lando model #40

kiniry opened this issue Dec 18, 2021 · 3 comments
Assignees
Labels
documentation Issues that relate to documentation about the system, including user and developer docs, source code Lando/Lobot Issues related to our Lando or Lobot specifications. Someday Issues that are not required by our current contract, but we'd like to attend to someday. specifications Issues that relate to system specifications, whether of models, code, protocols, or otherwise.

Comments

@kiniry
Copy link
Member

kiniry commented Dec 18, 2021

Our Lando model has over 200 outstanding @todo annotations in places where we have to drop in definitions/explanations for domain engineering model elements.

These explanations are not strictly necessary for the first implementation of the model, but need to be complete for final delivery of the system. We use them, in part, to check the completeness of the domain model and to generate the final glossary for the system.

This issue will track our progress on updating these explanations.

  • acronyms.lando 78 remaining
  • architecture.lando 31 remaining
  • dataflow.lando 13 remaining
  • glossary.lando 86 remaining
  • hardware.lando 19 remaining
  • requirements.lando needs to be filled in
@kiniry kiniry added documentation Issues that relate to documentation about the system, including user and developer docs, source code specifications Issues that relate to system specifications, whether of models, code, protocols, or otherwise. To Do Lando/Lobot Issues related to our Lando or Lobot specifications. labels Dec 18, 2021
@kiniry kiniry added this to the Task 3: Evaluation milestone Dec 18, 2021
@kiniry
Copy link
Member Author

kiniry commented Oct 28, 2022

I'm taking care of these during report polishing.

@kiniry kiniry self-assigned this Oct 28, 2022
@kiniry kiniry added WiP and removed To Do labels Oct 28, 2022
@kiniry kiniry modified the milestones: Task 3: Evaluation, End of POP Oct 28, 2022
@kiniry
Copy link
Member Author

kiniry commented Nov 1, 2022

I was unable to finish these in time for the final NRC release, so I am removing their milestone and will label them Someday.

@kiniry kiniry removed this from the End of POP milestone Nov 1, 2022
@kiniry kiniry added Someday Issues that are not required by our current contract, but we'd like to attend to someday. and removed WiP labels Nov 1, 2022
@kiniry kiniry added this to the Second Polishing Release milestone May 22, 2023
@kiniry
Copy link
Member Author

kiniry commented Nov 11, 2023

I'm using GPT-4 to revise these specifications now. I provided a prelude to explain HARDENS and RDE, then bootstrapped its understanding with an EBNF grammar of Lando and an explanation of our approach to domain engineering, then provided each partial specification in turn, reviewing the output for inclusion here. Here is the resulting transcript of my co-design with GPT-4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues that relate to documentation about the system, including user and developer docs, source code Lando/Lobot Issues related to our Lando or Lobot specifications. Someday Issues that are not required by our current contract, but we'd like to attend to someday. specifications Issues that relate to system specifications, whether of models, code, protocols, or otherwise.
Projects
None yet
Development

No branches or pull requests

1 participant