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.

Sign up for GitHub

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

Jump to bottom

Make documentation awesome #516

Open
Tracked by #396
blmalone opened this issue Jan 30, 2025 · 2 comments
Open
Tracked by #396

Make documentation awesome #516

blmalone opened this issue Jan 30, 2025 · 2 comments

Comments

@blmalone
Copy link
Contributor

The documentation for making your own template/reusing an existing template should be really good. The better our documentation the less time we have to spend hand holding users of superchain-ops.
@blmalone blmalone mentioned this issue Jan 30, 2025
Open
57 tasks
@blmalone
Copy link
Contributor Author

  1. Make sure the just file is created with the same nomenclature. We have a task for this already.
  2. Create a video for: a) creating new template type b) reusing an existing template
  3. Instructions for Task Developer on how to create a new template. This includes ci changes, README, VALIDATIONS, tests, broadly what PRs they need to make to fully complete a task (e.g. first PR with status DRAFT, second PR after execution status EXECTUTED with link to etherscan)

@blmalone
Copy link
Contributor Author

blmalone commented Feb 3, 2025

Some options:

  1. One giant readme file.
  2. Use mdbook in the repo - publish documentation in ci - the same way as we do for specs repo.

@ElliotFriedman ElliotFriedman mentioned this issue Feb 5, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@blmalone