Skip to content

docs: make getting started easier to follow#108

Merged
auxesis merged 4 commits intomainfrom
docs/restructure-for-better-first-nav
Mar 12, 2025
Merged

docs: make getting started easier to follow#108
auxesis merged 4 commits intomainfrom
docs/restructure-for-better-first-nav

Conversation

@auxesis
Copy link
Copy Markdown
Contributor

@auxesis auxesis commented Mar 12, 2025

  • fix(README): whitespace
  • docs(examples): move to the bottom of README
  • docs(getting-started): move getting started guide to a dedicated doc
  • docs(README): port improvements from getting started guide

auxesis added 2 commits March 12, 2025 21:14
We want people to use the example apps as reference, but we don't want
them to be the first thing people see.

Clears the way for more detailed getting started documentation earlier.
@auxesis auxesis force-pushed the docs/restructure-for-better-first-nav branch 2 times, most recently from 8049d22 to 20bf44b Compare March 12, 2025 12:57
auxesis added 2 commits March 13, 2025 01:40
Getting started in README should be a high-level overview of how to add
Protect.js to an existing app that the developer is bringing with them.
@auxesis auxesis force-pushed the docs/restructure-for-better-first-nav branch from e1e0ffe to 649e503 Compare March 12, 2025 14:58
@auxesis auxesis marked this pull request as ready for review March 12, 2025 15:00
@auxesis auxesis merged commit 3b79c24 into main Mar 12, 2025
1 check passed
@auxesis auxesis deleted the docs/restructure-for-better-first-nav branch March 12, 2025 15:16
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.

2 participants