Skip to content

docs(README): add debugging tips to README and docs #74

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

Merged
merged 5 commits into from
Mar 11, 2021
Merged

Conversation

rubinovitz
Copy link
Contributor

PR Description

PR Checklist

Testing

  • added relevant test coverage
  • no tests needed

Docs

Typescript

  • added or edited relevant Typescript type declarations
  • no type declaration updates needed

Merging

For maintainers.

To merge, select "Squash and Merge". Then:

  1. Make sure the top commit message follows Angular Git Commit Guidelines,
  2. Delete all other commit messages in the description, but keep any lines designating co-authors so contributors will retain credit for their contributions.

@vercel
Copy link

vercel bot commented Mar 10, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

homebase-example-todo – ./examples/todo

🔍 Inspect: https://vercel.com/homebaseio/homebase-example-todo/Dy4kLDtVLkJ8nYuNFfwVC5p7JXDY
✅ Preview: https://homebase-example-todo-git-debugging-tips-homebaseio.vercel.app

homebase-example-ts-firebase-todo – ./examples/typescript-firebase-todo

🔍 Inspect: https://vercel.com/homebaseio/homebase-example-ts-firebase-todo/37sWxaUp2ygcsqifjni55vYmFBv4
✅ Preview: https://homebase-example-ts-firebase-todo-git-debugging-tips-homebaseio.vercel.app

homebase-example-roam – ./examples/roam

🔍 Inspect: https://vercel.com/homebaseio/homebase-example-roam/2KfzTSpsA4ayoq368piMWQcD4E2s
✅ Preview: https://homebase-example-roam-git-debugging-tips-homebaseio.vercel.app

homebase-example-counter – ./examples/counter

🔍 Inspect: https://vercel.com/homebaseio/homebase-example-counter/5EBmftY6v35svWPheWMLvrdbET2y
✅ Preview: https://homebase-example-counter-git-debugging-tips-homebaseio.vercel.app

docs/0400|API.md Outdated
@@ -202,3 +202,13 @@ JSON.parse(company.get('matrix'))
```

For more information check out the [JSON Derived Relationships blog post](https://homebase.io/blog/homebase-react-0.5.0-json-derived-relationships)

## Debugging tips
Copy link
Member

Choose a reason for hiding this comment

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

I would consider nesting this under the HomebaseProvider heading

Copy link
Member

Choose a reason for hiding this comment

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

And maybe also creating a separate troubleshooting or FAQ page if you think this should be an H2 on its own

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll nest it under HomebaseProvider for now but can break it out into a separate page when we add the incoming tooling.

@@ -187,6 +187,16 @@ This hook returns the current database client with some helpful functions for sy

Check out the [Firebase example](https://homebaseio.github.io/homebase-react/#!/example.todo_firebase) for a demonstration of how you might integrate a backend.

## Debugging tips
Copy link
Member

Choose a reason for hiding this comment

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

🙌🏽

@crs48 crs48 merged commit 2ce3cc3 into master Mar 11, 2021
@crs48 crs48 deleted the debugging-tips branch March 11, 2021 19:45
@github-actions
Copy link

github-actions bot commented Apr 7, 2021

🎉 This PR is included in version 0.5.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

2 participants