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

Ensure shell commands in docs are correct and outputs are valid #2479

Open
cptartur opened this issue Sep 17, 2024 · 0 comments
Open

Ensure shell commands in docs are correct and outputs are valid #2479

cptartur opened this issue Sep 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@cptartur
Copy link
Member

Which components does the task require to be changed? (think hard pls)

snforge, sncast

Description

Right now, we do not have any mechanism for validating if shell commands (e.g. calls to snforge test etc) in docs are up to date and correct. We should ensure that any command that user can copy from the documentation works and behaves as described.

An minimal solution would be ensuring that the commands are in fact runnable and execute correctly.

Later (feel free to create a separate task for that after minimal is implemented), we should introduce a mechanism to validate if outputs included in the documentation match these produced by the real program.

@cptartur cptartur added the documentation Improvements or additions to documentation label Sep 17, 2024
@github-actions github-actions bot added the new label Sep 17, 2024
@cptartur cptartur removed the new label Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Triage
Development

No branches or pull requests

1 participant