#72 Storybook docs #78

choir241 · 2024-03-19T18:22:28Z

Created core categories to break down documentation into the following sections:

Welcome
About
Components
Documents

Added content to the Developer Guide to visualize basic layout and storybook default styling for documentations.

…installation page

…gate documentation for application

…or streamline, easy-to-navigate documentation for the application

…aking down into smaller sections for streamline, easy-to-navigate documentation for application. Add content to Developer Guide as a visualization for future documentation

vercel · 2024-03-19T18:22:34Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
gridiron-survivor	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 2, 2024 5:10pm

shashilo

@choir27 A few comments for you to review. Can you capture a video of the changes you made? It's a lot easier to review than me spinning it up locally to review the visuals.

README.md

shashilo · 2024-03-27T01:42:02Z

stories/Components/Components.mdx

Do we need this file?

I would like to have this file in our documentation, it will serve as a good introduction page to the components, while also hosting a grid gallery of previews for how each component visually looks.

But it's empty right now. Is it still needed?

Technically right now it isn't needed as there is no content in it.

__tests__/Home.test.tsx

components/Home.tsx

package-lock.json

README.md

stories/About/Developer Guide.mdx

…hanges to __tests__/Home.test.tsx

…gridiron-survivor into storybook-docs with PR comments

…n-survivor into storybook-docs

…gridiron-survivor into storybook-docs

choir241 · 2024-04-02T15:57:34Z

https://www.youtube.com/watch?v=rIt8WBgqOEU&feature=youtu.be

shashilo

@choir27 please review my comments.

shashilo · 2024-04-02T16:25:02Z

stories/About/Developer Guide.mdx

+ <section>
+<h3>Table of Contents</h3>
+      <ol>
+        <li><a href = "#started">Getting Started</a></li>


These should be formated like this.

Suggested change

<li><a href = "#started">Getting Started</a></li>

<li><a href="#started">Getting Started</a></li>

shashilo · 2024-04-02T16:25:18Z

stories/About/Developer Guide.mdx

+        <li><a href = "#query">Query Supabase data from Next.js</a></li>
+      </ol>
+
+<h3 id = "started">Getting Started</h3>


Same here and thorought this PR code changes.. Fix the attribute formatting.

shashilo · 2024-04-02T16:27:20Z

stories/About/Developer Guide.mdx

+</div>
+
+
+<style>


@emestabillo These styles should live in its own SCSS file. Can you provide some direction or guidance on where this should live?

shashilo · 2024-04-02T16:28:00Z

stories/About/Developer Guide.mdx

+<Meta title="About/Developer Guide" />
+
+<div className="sb-container">
+  <div className='sb-section-title'>


Inconsistent usage of double and single quotes. Work with @ryandotfurrer on the coding standards for this project.

shashilo · 2024-04-02T16:28:23Z

stories/About/Developer Guide.mdx

+<h3 id = "started">Getting Started</h3>
+<ol>
+  <li>Clone the develop branch to your local machine:</li>
+  <li><code>git clone --single-branch --branch develop https://github.com/LetsGetTechnical/gridiron-survivor.git</code></li>


This is where the link should go to a new page. Anything outside of the Storybook infrastructure.

choir241 · 2024-04-02T17:11:06Z

Richard.mdx is neccessary for Documents section to be created in storybook
https://www.youtube.com/watch?v=IFutQJA-dNI&ab_channel=RichardChoi

shashilo

@choir27 Please review my comments.

shashilo · 2024-04-02T20:07:58Z

package.json

@@ -4,8 +4,9 @@
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
-    "test": "jest",
-    "test:watch": "jest --watchAll",
+    "test": "jest --passWithNoTests",


What was this param added to the script?

When pulling from the develop's most recent changes (removing Home component and test folder), I was geting the following error in my PR when trying to push into the storybook-docs branch:

Run pnpm test > @ test /home/runner/work/gridiron-survivor/gridiron-survivor > jest No tests found, exiting with code 1 Run with `--passWithNoTests` to exit with code 0 In /home/runner/work/gridiron-survivor/gridiron-survivor 29 files checked. testMatch: **/__tests__/**/*.[jt]s?(x), **/?(*.)+(spec|test).[tj]s?(x) - 0 matches testPathIgnorePatterns: /node_modules/, /.next/ - 29 matches testRegex: - 0 matches Pattern: - 0 matches ELIFECYCLE Test failed. See above for more details. Error: Process completed with exit code 1.

So after consulting with Mai to debug the error, after some research in regards to this particular error, she failed to duplicate the same error as my local machine/PR. Our inference is that my machine still remembers the tests, and therefore is still looking for them; therefore it fails the Docker test because there are no tests to look for.

I believe this is ok for now until we add our 1st test. Then, we need to remove this.

shashilo · 2024-04-02T20:08:28Z

package.json

@@ -16,38 +17,39 @@
    "autoprefixer": "10.4.15",
    "class-variance-authority": "^0.7.0",
    "clsx": "^2.1.0",
-    "geist": "^1.0.0",
+    "geist": "^1.2.2",


Is there a reason why some of these packages were upgraded? We need to be very careful when upgrading versions.

I don't recall upgrading anything when I was making changes, but I did have to pull from develop's new changes (removing Home component and test folder) in order to successfully make the push to my PR and merge into develop.

I believe this happened because there wasn't a package.lock file that was committed. So your installation command installed and updated to the latest packages. Once a package.lock file is in our repo, the only time we should upgrade our packages are when we need them to be upgraded. And not an automatic script that does it for us.

choir241 added 5 commits March 15, 2024 16:37

build core code for storybook integregated documentation landing and …

a17340a

…installation page

rm 53-storybook-shadcn-setup

a2d9fc1

categorize and organize docs and stories for streamline, easy-to-navi…

c667636

…gate documentation for application

figure out how to properly categorize and organize docs and stories f…

6e02638

…or streamline, easy-to-navigate documentation for the application

finish the categorization and organization of docs and stories by bre…

2949240

…aking down into smaller sections for streamline, easy-to-navigate documentation for application. Add content to Developer Guide as a visualization for future documentation

choir241 requested review from shashilo, mhchen and jayrobin as code owners March 19, 2024 18:22

add Home component to pass Docker test

b66cf58

vercel bot deployed to Preview March 21, 2024 18:51 View deployment

download @types/jest to clear error messages for local devices

211ed68

vercel bot had a problem deploying to Preview March 21, 2024 18:58 Failure

update pnpm-lock.yaml

06a5421

vercel bot deployed to Preview March 21, 2024 19:18 View deployment

shashilo changed the title ~~Storybook docs~~ #67 Storybook docs Mar 22, 2024

shashilo changed the title ~~#67 Storybook docs~~ Storybook docs Mar 22, 2024

shashilo changed the title ~~Storybook docs~~ #72 Storybook docs Mar 22, 2024

Merge branch 'develop' into storybook-docs

29967df

vercel bot deployed to Preview March 27, 2024 01:42 View deployment

shashilo requested changes Mar 27, 2024

View reviewed changes

emestabillo requested changes Mar 27, 2024

View reviewed changes

package-lock.json Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

stories/About/Developer Guide.mdx Outdated Show resolved Hide resolved

choir241 added 2 commits March 27, 2024 15:11

fix README.md line 98, remove Home.tsx from components page, revert c…

174baee

…hanges to __tests__/Home.test.tsx

Merge branch 'storybook-docs' of https://github.com/LetsGetTechnical/…

77b4178

…gridiron-survivor into storybook-docs with PR comments

vercel bot deployed to Preview March 27, 2024 19:14 View deployment

tentatively remove arrows in documentation navigation links

014e5fc

vercel bot deployed to Preview March 31, 2024 22:19 View deployment

Merge branch 'develop' of https://github.com/LetsGetTechnical/gridiro…

94e13f4

…n-survivor into storybook-docs

vercel bot deployed to Preview April 1, 2024 15:07 View deployment

choir241 linked an issue Apr 1, 2024 that may be closed by this pull request

Create Storybook documentation sections #72

Closed

vmaineng and others added 4 commits April 1, 2024 14:50

added test

f83fff3

Merge branch 'test-storybook' of https://github.com/LetsGetTechnical/…

a84f2cf

…gridiron-survivor into storybook-docs

storybook documentation section

30a35ad

storybook documentation sections

5d08f55

vercel bot deployed to Preview April 2, 2024 13:37 View deployment

update package.json jest scripts

6277b3c

vercel bot deployed to Preview April 2, 2024 14:03 View deployment

choir241 requested review from shashilo and emestabillo April 2, 2024 14:05

shashilo requested changes Apr 2, 2024

View reviewed changes

remove extra content

0fd290c

vercel bot deployed to Preview April 2, 2024 16:35 View deployment

add internal documenation navigation

f931766

vercel bot deployed to Preview April 2, 2024 17:10 View deployment

shashilo requested changes Apr 2, 2024

View reviewed changes

shashilo approved these changes Apr 2, 2024

View reviewed changes

emestabillo approved these changes Apr 2, 2024

View reviewed changes

choir241 merged commit ed2de99 into develop Apr 2, 2024
4 checks passed

choir241 deleted the storybook-docs branch April 2, 2024 20:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#72 Storybook docs #78

#72 Storybook docs #78

choir241 commented Mar 19, 2024

vercel bot commented Mar 19, 2024 •

edited

Loading

shashilo left a comment

shashilo Mar 27, 2024

choir241 Mar 27, 2024

shashilo Apr 2, 2024

choir241 Apr 2, 2024

choir241 commented Apr 2, 2024

shashilo left a comment

shashilo Apr 2, 2024

shashilo Apr 2, 2024

shashilo Apr 2, 2024

shashilo Apr 2, 2024

shashilo Apr 2, 2024

choir241 commented Apr 2, 2024 •

edited

Loading

shashilo left a comment

shashilo Apr 2, 2024

choir241 Apr 2, 2024 •

edited

Loading

shashilo Apr 2, 2024

shashilo Apr 2, 2024

choir241 Apr 2, 2024 •

edited

Loading

shashilo Apr 2, 2024

	<li><a href = "#started">Getting Started</a></li>
	<li><a href="#started">Getting Started</a></li>

		</div>


		<style>

#72 Storybook docs #78

#72 Storybook docs #78

Conversation

choir241 commented Mar 19, 2024

vercel bot commented Mar 19, 2024 • edited Loading

shashilo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

choir241 commented Apr 2, 2024

shashilo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

choir241 commented Apr 2, 2024 • edited Loading

shashilo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

choir241 Apr 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

choir241 Apr 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Mar 19, 2024 •

edited

Loading

choir241 commented Apr 2, 2024 •

edited

Loading

choir241 Apr 2, 2024 •

edited

Loading

choir241 Apr 2, 2024 •

edited

Loading