Skip to content

Docs edits #597

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.

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

Open
wants to merge 36 commits into
base: docs-edits
Choose a base branch
from
Open

Docs edits #597

wants to merge 36 commits into from

Conversation

chideraao
Copy link
Collaborator

PR containing changes from the previous repo, as well as changes over the last couple of days.

Copy link

vercel bot commented Jun 11, 2025

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

Name Status Preview Comments Updated (UTC)
docs ❌ Failed (Inspect) Jun 13, 2025 11:44am

@@ -11,6 +11,9 @@ docs/.obsidian
.docusaurus
.cache-loader
.yarnclean
.yarn
Copy link
Collaborator Author

@chideraao chideraao Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These (L14-L16) were auto-generated files created after I ran yarn install. You mentioned earlier about the yarn.lock file being fragile, so I added these files to the gitignore file to avoid any accidents.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted this since it is usually created by an npm install and we recommend using yarn in the docs README.
Wanted to avoid a situation where someone unknowingly serves the docs using npm to avoid any errors.

package.json Outdated
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like the item was just moved around a bit. noticed it after the yarn install

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants