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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Split up the main README #306

Closed
1 task
adhilto opened this issue Jun 5, 2024 · 1 comment 路 Fixed by #319
Closed
1 task

Split up the main README #306

adhilto opened this issue Jun 5, 2024 · 1 comment 路 Fixed by #319
Assignees
@adhilto
Labels
improvement This issue or pull request will add new or improve existing functionality
Milestone
Coast

Comments

@adhilto
Copy link
Collaborator

adhilto commented Jun 5, 2024 •
edited
Loading

馃挕 Summary

Split up the main README into separate files.

Motivation and context

The README is growing large and unwieldy. Splitting it into smaller files will improve readability and maintainability.

Implementation notes

See ScubaGear's README for reference: https://github.com/cisagov/ScubaGear/tree/main

Acceptance criteria

  • The README has been split into different files, using a structure similar to ScubaGear's documentation.
@adhilto adhilto added the improvement This issue or pull request will add new or improve existing functionality label Jun 5, 2024
@LaurenBassett
Copy link
Collaborator

Linking #283 since it is a readme related issue

@adhilto adhilto self-assigned this Jun 11, 2024
@adhilto adhilto mentioned this issue Jun 13, 2024
Merged
14 tasks
@adhilto adhilto linked a pull request Jun 13, 2024 that will close this issue
Documentation Rehaul #319
Merged
14 tasks
@adhilto adhilto added this to the Coast milestone Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adhilto adhilto

Labels
improvement This issue or pull request will add new or improve existing functionality
Projects
None yet
Milestone
Coast
Development

Successfully merging a pull request may close this issue.

Documentation Rehaul cisagov/ScubaGoggles
2 participants
@LaurenBassett @adhilto