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

Add React setup instructions to documentation #346

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

AdarshSahani003
Copy link

This PR enhances the Getting Started Guide by adding setup instructions for React, alongside the existing Vue setup guide.


What’s New

  • Clear Setup Steps: Comprehensive instructions for setting up a React project using Ferrostar.
  • Comparison Highlights: Points out key differences between Vue and React setups for better understanding.

Why This Matters

Including React instructions makes the guide more accessible and developer-friendly for those who prefer React, broadening the usability of the framework.


Feedback and Suggestions

I’d love to hear your thoughts, feedback, or suggestions! Your input is valuable and will help improve the guide further.

@ianthetechie ianthetechie self-requested a review November 5, 2024 01:28
Copy link
Contributor

@ianthetechie ianthetechie left a comment

Choose a reason for hiding this comment

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

This seems like it replaces the existing web standards language and examples with React, which is a bit weird. This should add information about React specifics, not remove existing good info :)

I think you also missed a section further down ("Configuration explained") which has a section on Vue. React does not (as far as I know) support web components natively, so this would be a perfect spot to talk about whatever the best way to do things is in React for binding properties.

guide/src/web-getting-started.md Outdated Show resolved Hide resolved
guide/src/web-getting-started.md Outdated Show resolved Hide resolved
guide/src/web-getting-started.md Outdated Show resolved Hide resolved
guide/src/web-getting-started.md Show resolved Hide resolved
Copy link
Contributor

@ianthetechie ianthetechie left a comment

Choose a reason for hiding this comment

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

Could you have a look over the formatting again and ensure it matches the styling of other guides? We don't really use horizontal rules, and we prefer to have the code indented per language norms as it's very hard to read otherwise.

Out of curiosity, do you have a readily reproducible example (separate git repo, CodeSandbox, etc.) so that we could test it out? We aren't regular users of React on the core team, so we'd want to be able to easily verify that this works.

Here we have used Stadia Maps URLs, which should work without authentication for local development.
(Refer to the [authentication docs](https://docs.stadiamaps.com/authentication/)
for network deployment details; you can start with a free account.)
## React
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe that the first example should remain generic, and we should have separate sections for framework-specific (React, Vue, etc.) code. This appears to replace the generic code, which is applicable to a large number of users, with a React-specific example.

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