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.

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

docs: Update docs README #5

Merged
merged 4 commits into from
Nov 23, 2024
Merged

Conversation

Sporiff
Copy link
Contributor

@Sporiff Sporiff commented Nov 23, 2024

This is a small PR to update the README in the docs folder with new instructions relating to the use of pnpm monorepo and to give more help to users who aren't familiar with GitHub workflows. It introduces the following:

  • Unified periods at the end of lists.
  • Updated links for the new repository.
  • More links to documentation to help inexperienced users.
  • Updated instructions for pnpm monorepo.
  • Unified linefeed usage.

Standardize lists and add lines to prevent header skips

Improve formatting and add more links to documentation
@Sporiff Sporiff changed the title Update docs README Docs: Update docs README Nov 23, 2024
@Sporiff Sporiff changed the title Docs: Update docs README docs: Update docs README Nov 23, 2024
docs/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@patak-dev patak-dev left a comment

Choose a reason for hiding this comment

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

Awesome!

@patak-dev patak-dev merged commit dad7e66 into nimbus-town:main Nov 23, 2024
2 checks passed
@Sporiff Sporiff deleted the update-docs-readme branch November 23, 2024 20:01
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