docs: enhance localhost documentation with REST API URL #7317
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add callout for local REST API URL alongside the GraphQL API URL. - This change aims to reduce confusion and complexity for the self-hosted community.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Enhanced local setup documentation by adding information about the REST API URL alongside the existing GraphQL API URL.
- Added REST API URL (http://localhost:3000/rest) in
/packages/twenty-website/src/content/developers/local-setup.mdx - Improved clarity for users setting up the project locally by providing comprehensive server endpoint information
- Addresses issue (Docs) Enhance local hosting docs with reference to the REST API url as well as the Graphql API url #7316 to enhance local hosting documentation with REST API reference
- Aims to reduce confusion for self-hosted community by including both GraphQL and REST API URLs
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
FelixMalfait
approved these changes
Sep 29, 2024
harshit078
pushed a commit
to harshit078/twenty
that referenced
this pull request
Oct 14, 2024
- Add callout for local REST API URL alongside the GraphQL API URL. - This change aims to reduce confusion and complexity for the self-hosted community. **Associated Issue - "(Docs) Enhance local hosting docs with reference to the REST API URL as well as the Graphql API URL [twentyhq#7316]"**
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Associated Issue - "(Docs) Enhance local hosting docs with reference to the REST API URL as well as the Graphql API URL [#7316]"