department-of-veterans-affairs / next-build

Front-end templating, build, and deploy for VA.gov CMS content.
Creative Commons Zero v1.0 Universal
9 stars 5 forks source link

[AP] Build content guide for Next Build #711

Closed mreed101 closed 1 month ago

mreed101 commented 2 months ago

Description

Next Build currently contains extensive documentation but it can be difficult for developers to quickly digest and find critical information. To improve this we propose creating a comprehensive ReadMe or GitHub Wiki page that provides a clear and concise guide to get developers up and running with the next-build project.

This documentation will serve as a resource for both new and existing developers, streamlining their workflow and reducing the time spent searching for solutions.

Acceptance Criteria

nfpappas-oddball commented 2 months ago

Started an index page. Mostly just modified the default readme to be this page. code is on branch origin/next_index_documentation

jcbolling commented 1 month ago

This ticket moved into Sprint 16 to allow time to meet with Nick so he could review the common issues identified by the rest of the team and provide his feedback. Nick and I met yesterday and reviewed the document.