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

fix: typos according to the issue 01-introduction.md Docs Feedback #40 #43

Merged
merged 1 commit into from
Apr 12, 2024

Conversation

glaucia86
Copy link
Contributor

Purpose

This PR is related to the issue #40

  • ...

Does this introduce a breaking change?

[ ] Yes
[ ] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[ ] Other... Please describe:

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

This pull request includes significant changes to the docs/tutorial/01-introduction.md file to enhance clarity and readability. The changes focus on refining the tutorial's language, reorganizing content for better flow, and providing more precise instructions.

Language Refinements:

  • Changed phrases to make the tutorial more reader-friendly and precise. For example, "Here's an example of the application in action" instead of "The final result of this application can be seen in the following picture".
  • Replaced passive voice with active voice to make the sentences more engaging and clear. For example, "You'll be guided through each step of the process" instead of "We will guide you explaining each step of the process".

Content Reorganization:

  • Reordered the sections about running the application locally and using Codespaces for a smoother transition. [1] [2]
  • Removed the redundant "Codespaces" section and integrated its content into the previous section for a more streamlined reading experience.

Instructions Precision:

  • Made instructions more specific and clear. For example, "Run the application using Codespaces" instead of "using Codespaces".
  • Provided more detailed descriptions about the project architecture and application flow.

@glaucia86 glaucia86 self-assigned this Apr 12, 2024
@sinedied sinedied merged commit 1b71811 into main Apr 12, 2024
5 checks passed
@sinedied sinedied deleted the GL/fix-introduction-tutorial branch April 12, 2024 06:50
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