Skip to content

Comments

docs: restructure Getting Started with prerequisites and clearer sect…#619

Open
anishasingh-dev wants to merge 1 commit intopubliclab:mainfrom
anishasingh-dev:patch-1
Open

docs: restructure Getting Started with prerequisites and clearer sect…#619
anishasingh-dev wants to merge 1 commit intopubliclab:mainfrom
anishasingh-dev:patch-1

Conversation

@anishasingh-dev
Copy link

…ions

This change improves the Getting Started documentation by restructuring the content and adding a clear Prerequisites section.

The guide is now easier to follow for new contributors, with better sectioning, clearer setup steps, and improved readability without changing any technical behavior.

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

  • tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with rake test
  • code is in uniquely-named feature branch and has no merge conflicts
  • PR is descriptively titled
  • PR body includes fixes #0000-style reference to original issue #
  • ask @publiclab/reviewers for help, in a comment below

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software

We have a loose schedule of reviewing and pulling in changes every Tuesday and Friday, and publishing changes on Fridays.

Thanks!

…ions

This change improves the Getting Started documentation by restructuring the content
and adding a clear Prerequisites section.

The guide is now easier to follow for new contributors, with better sectioning,
clearer setup steps, and improved readability without changing any technical behavior.
@anishasingh-dev
Copy link
Author

Thanks! This PR only updates documentation and does not change any code.
Happy to make adjustments if needed.

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.

1 participant