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

Cherry-pick v2 docs from dev into release-next #7408

Merged
merged 29 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
7ce2354
Add docs on error santization (#7315)
brophdawg11 Aug 31, 2023
5967851
chore: format
remix-run-bot Aug 31, 2023
df305ce
docs: form
ryanflorence Aug 29, 2023
49deef4
docs: link docs
ryanflorence Aug 31, 2023
60064f1
chore: format
remix-run-bot Aug 31, 2023
78add14
docs: NavLink
ryanflorence Aug 31, 2023
0396288
chore: format
remix-run-bot Aug 31, 2023
c5dcff2
docs: outlet
ryanflorence Aug 31, 2023
267b339
docs: Scripts
ryanflorence Aug 31, 2023
9d38b94
docs: scroll restoration
ryanflorence Sep 1, 2023
f45397d
docs: useActionData
ryanflorence Sep 1, 2023
550ee66
chore: format
remix-run-bot Sep 1, 2023
ed9882a
docs stuff
ryanflorence Sep 3, 2023
888c9a8
chore: format
remix-run-bot Sep 3, 2023
7edad5b
docs: more API docs updates
ryanflorence Sep 5, 2023
5ac0095
chore: format
remix-run-bot Sep 5, 2023
4568185
docs: useFetchers
ryanflorence Sep 5, 2023
61c913e
chore: format
remix-run-bot Sep 5, 2023
b92ddde
docs: useFormAction
ryanflorence Sep 5, 2023
7c859c1
docs: useHref
ryanflorence Sep 5, 2023
825dae8
docs: useLoaderData
ryanflorence Sep 5, 2023
a7635f3
chore: format
remix-run-bot Sep 5, 2023
03b2a38
docs: useLocation
ryanflorence Sep 5, 2023
aa6d476
chore: format
remix-run-bot Sep 5, 2023
d31cfeb
docs: moving stuff around
ryanflorence Sep 13, 2023
af495a1
docs: fix links to moved files
ryanflorence Sep 13, 2023
ba3906c
docs: nothin
ryanflorence Sep 13, 2023
cb480d9
docs: update main index page
ryanflorence Sep 13, 2023
9cc2966
Change docs cards to point to main
brophdawg11 Sep 13, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: fix links to moved files
  • Loading branch information
ryanflorence authored and brophdawg11 committed Sep 13, 2023
commit af495a16ce8bd3c06f29e41ff8e57e4ed4904209
8 changes: 4 additions & 4 deletions docs/components/form.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ See also:
[data-mutations-with-form-action]: https://www.youtube.com/watch?v=Iv25HAHaFDs&list=PLXoynULbYuEDG2wBFSZ66b85EIspy3fy6
[multiple-forms-and-single-button-mutations]: https://www.youtube.com/watch?v=w2i-9cYxSdc&list=PLXoynULbYuEDG2wBFSZ66b85EIspy3fy6
[clearing-inputs-after-form-submissions]: https://www.youtube.com/watch?v=bMLej7bg5Zo&list=PLXoynULbYuEDG2wBFSZ66b85EIspy3fy6
[fullstack-data-flow]: ../discussion/03-data-flow
[pending-ui]: ../discussion/07-pending-ui
[form-vs-fetcher]: ../discussion/10-form-vs-fetcher
[fullstack-data-flow]: ../discussion/data-flow
[pending-ui]: ../discussion/pending-ui
[form-vs-fetcher]: ../discussion/form-vs-fetcher
[fetcher-form]: ../hooks/use-fetcher
[progressive-enhancement]: ../discussion/06-progressive-enhancement
[progressive-enhancement]: ../discussion/progressive-enhancement
2 changes: 1 addition & 1 deletion docs/discussion/concurrency.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ All the application needs to know is how to query the data and how to render it,

Remix offers developers an intuitive, browser-based approach to managing network requests. By mirroring browser behaviors and enhancing them where needed, it simplifies the complexities of concurrency, revalidation, and potential race conditions. Whether you're building a simple webpage or a sophisticated web application, Remix ensures that your user interactions are smooth, reliable, and always up-to-date.

[fullstack-data-flow]: ./03-data-flow
[fullstack-data-flow]: ./data-flow
2 changes: 1 addition & 1 deletion docs/discussion/form-vs-fetcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,4 +256,4 @@ function UserAvatar({ partialUser }) {

Remix offers a range of tools to cater to varied developmental needs. While some functionalities might seem to overlap, each tool has been crafted with specific scenarios in mind. By understanding the intricacies and ideal applications of `<Form>`, `useSubmit`, `useNavigation`, `useActionData`, and `useFetcher`, developers can create more intuitive, responsive, and user-friendly web applications.

[network-concurrency-management]: ./09-concurrency
[network-concurrency-management]: ./concurrency
6 changes: 0 additions & 6 deletions docs/discussion/forms-vs-usesubmit-vs-fetcher.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/discussion/progressive-enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,4 @@ No fundamental change in architecture, simply a progressive enhancement for both
See also: [State Management][state-management]

[wikipedia]: https://en.wikipedia.org/wiki/Progressive_enhancement
[state-management]: ./08-state-management
[state-management]: ./state-management
4 changes: 2 additions & 2 deletions docs/discussion/state-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -501,5 +501,5 @@ As bonus party trick, the form is functional even before JavaScript loads. Inste

If you ever find yourself entangled in managing and synchronizing state for network operations, Remix likely offers a more elegant solution.

[fullstack-data-flow]: ./03-data-flow
[pending-ui]: ./07-pending-ui
[fullstack-data-flow]: ./data-flow
[pending-ui]: ./pending-ui
2 changes: 1 addition & 1 deletion docs/hooks/use-action-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ export default function Invoices() {
[usenavigation]: ../hooks/use-navigation
[rr-useactiondata]: https://reactrouter.com/hooks/use-action-data
[form-validation]: ../guides/form-validation
[fullstack-data-flow]: ../discussion/03-data-flow
[fullstack-data-flow]: ../discussion/data-flow
4 changes: 2 additions & 2 deletions docs/hooks/use-fetcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The form method of the submission.
- [Concurrent Mutations w/ useFetcher][concurrent-mutations-w-use-fetcher]
- [Optimistic UI][optimistic-ui]

[form-vs-fetcher]: ../discussion/10-form-vs-fetcher
[network-concurrency-management]: ../discussion/09-concurrency
[form-vs-fetcher]: ../discussion/form-vs-fetcher
[network-concurrency-management]: ../discussion/concurrency
[concurrent-mutations-w-use-fetcher]: https://www.youtube.com/watch?v=vTzNpiOk668&list=PLXoynULbYuEDG2wBFSZ66b85EIspy3fy6
[optimistic-ui]: https://www.youtube.com/watch?v=EdB_nj01C80&list=PLXoynULbYuEDG2wBFSZ66b85EIspy3fy6
4 changes: 2 additions & 2 deletions docs/hooks/use-fetchers.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ The fetchers don't contain `fetcher.Form`, `fetcher.submit`, or `fetcher.load`,

- [`useFetcher`][use-fetcher]

[form-vs-fetcher]: ../discussion/10-form-vs-fetcher
[pending-optimistic-ui]: ../discussion/07-pending-ui
[form-vs-fetcher]: ../discussion/form-vs-fetcher
[pending-optimistic-ui]: ../discussion/pending-ui
[use-fetcher]: ./use-fetcher
4 changes: 2 additions & 2 deletions docs/hooks/use-loader-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default function Invoices() {
- [`loader`][loader]
- [`useFetcher`][use-fetcher]

[fullstack-data-flow]: ../discussion/03-data-flow
[state-management]: ../discussion/08-state-management
[fullstack-data-flow]: ../discussion/data-flow
[state-management]: ../discussion/state-management
[loader]: ../route/loader
[use-fetcher]: ./use-fetcher
2 changes: 1 addition & 1 deletion docs/start/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ What's next?

- [Tutorial][tutorial]

[runtimes]: ../discussion/01-runtimes
[runtimes]: ../discussion/runtimes
[inspect]: https://nodejs.org/en/docs/guides/debugging-getting-started/
[tutorial]: ./tutorial
[remix-config]: ../file-conventions/remix-config
Expand Down