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

Autofill spawned-by and spawns #9

Open
lawndoc opened this issue Oct 4, 2022 · 1 comment
Open

Autofill spawned-by and spawns #9

lawndoc opened this issue Oct 4, 2022 · 1 comment
Assignees
Labels
development Enhancing the developer experience for maintaining the project enhancement New feature or request

Comments

@lawndoc
Copy link
Owner

lawndoc commented Oct 4, 2022

Moving the following suggestion from #6 to a separate issue:

May I also suggest having the Spawned-by be autofilled whenever an exe is added that uses it?

I like the idea of auto-filling it, but the tricky part would be maintaining that as the number of docs grows. Maybe we could create a custom script to run via GitHub actions that scans any new/updated docs and autofills related documents. I'll ponder that one, but I think it's possible. Any comments or other ideas are welcomed :)

I'll assign this one to me for now.

@lawndoc lawndoc self-assigned this Oct 4, 2022
@lawndoc lawndoc added the enhancement New feature or request label Oct 4, 2022
@lawndoc
Copy link
Owner Author

lawndoc commented Oct 4, 2022

I think to keep things accurate we would have to do 2 things with a script on new/updated binary docs:

  1. Update existing docs affected by the new/updated doc
  2. Scan for the binary in existing docs and update new docs with things that were missed

Part 2 could optionally be replaced with a separate script to generate a new doc with some fields auto-filled from existing docs. Then part 1 would be the only thing the CI script has to do.

@lawndoc lawndoc added the development Enhancing the developer experience for maintaining the project label Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Enhancing the developer experience for maintaining the project enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant