brightsign / dev-cookbook

Templates, examples, and recipes for BrightSign devices ๐Ÿ‘ฉโ€๐Ÿณ
MIT License
9 stars 1 forks source link

refactor: PE-411 repository structure should be reorganized to make initial impression simple #60

Closed jdmedlin1 closed 2 months ago

jdmedlin1 commented 3 months ago

๐Ÿ“ Description

The current layout of the repository is not friendly for newcomers; having all templates, examples, configs, etc. thrown at the user at once.

I propose we categorize the projects into their respective directories for the sake of simplifying the variance of types of info at once. Templates and examples should be put in their own repositories.

With this change, we will need to adjust npm scripts to point to the same projects. Additionally, we will need to give each new directory its own README as defined in https://brightsign.atlassian.net/browse/PE-410

๐Ÿ“‹ List of Changes

๐Ÿงช Steps to Test

  1. Step 1

Notes to the Reviewer

๐Ÿ“ธ Screenshots

โœ”๏ธ Dev Complete Checklist

bhastings1019 commented 2 months ago

Is this Draft PR ready for review?

bhastings1019 commented 2 months ago

The root README may benefit from refining the written form to present HTML (JavaScript) or Node Application, with direct links to each near the top.

We'll look back over some of these READMEs

jdmedlin1 commented 2 months ago

Just need a reapproval on this since GitHub is blocking it.