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

docs: fixed typos and small enhancements in en docs, fixed dead links in de #567 #566

Merged
merged 20 commits into from
Mar 8, 2024

Conversation

colinscz
Copy link
Contributor

@colinscz colinscz commented Mar 3, 2024

πŸ”— Linked issue

Closes #567

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Fixed some typos in the documentation and adjusted the descriptions where I saw fit so the "reading flow" is a bit better :)
I checked this draft PR and it seems that my changes do not overlap with it: #495

Also there were some german links that the linter marked as dead or incorrect, I fixed those too.
Resolves #567

πŸ“ Checklist

  • I have linked an issue or discussion.
  • It's submitted to the main branch
  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)
  • I have updated the documentation accordingly.
  • All tests are passing
  • New/updated tests are included

Other information:

caveats, composables, devtools, migration guide and troubleshooting pages
Copy link

netlify bot commented Mar 3, 2024

βœ… Deploy Preview for tresjs-docs ready!

Name Link
πŸ”¨ Latest commit 1c4d8d0
πŸ” Latest deploy log https://app.netlify.com/sites/tresjs-docs/deploys/65ea158175d08a0008f336e8
😎 Deploy Preview https://deploy-preview-566--tresjs-docs.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@colinscz colinscz changed the title docs: fixed typos and small enhancements in docs docs: fixed typos and small enhancements in en docs Mar 3, 2024
@colinscz colinscz changed the title docs: fixed typos and small enhancements in en docs docs: fixed typos and small enhancements in en docs #567 Mar 3, 2024
docs/guide/index.md Outdated Show resolved Hide resolved
@colinscz colinscz marked this pull request as ready for review March 3, 2024 19:20
Copy link
Contributor

@andretchen0 andretchen0 left a comment

Choose a reason for hiding this comment

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

Thanks for this! Lots of good changes here.

I made some comments. Most are "non-blocking" and are marked.

For those not marked "non-blocking" reply to me if you disagree. Otherwise, if you find the changes acceptable, go ahead and add them to the PR.

(I should say up front that I'm not an editor. My only "qualification" here is being an anglophone working on Tres/Cientos!)

Thanks again!

docs/examples/lights-shadows.md Outdated Show resolved Hide resolved
docs/examples/lights-shadows.md Outdated Show resolved Hide resolved
docs/examples/load-models.md Outdated Show resolved Hide resolved
docs/examples/load-models.md Outdated Show resolved Hide resolved
docs/examples/orbit-controls.md Outdated Show resolved Hide resolved
docs/guide/your-first-scene.md Outdated Show resolved Hide resolved
docs/guide/your-first-scene.md Outdated Show resolved Hide resolved
docs/guide/your-first-scene.md Outdated Show resolved Hide resolved
@colinscz
Copy link
Contributor Author

colinscz commented Mar 4, 2024

@andretchen0 I addressed all your comments since I like the approach of fixing things that only take a minute right away. πŸ€™πŸ½

Please have a second look at it, I also rephrased the part with the "in summary". But probably one person of the core team should comment on that point anyway.

@colinscz colinscz changed the title docs: fixed typos and small enhancements in en docs #567 docs: fixed typos and small enhancements in en docs, fixed dead links in de #567 Mar 4, 2024
docs/de/guide/nuxt.md Outdated Show resolved Hide resolved
Copy link
Contributor

@andretchen0 andretchen0 left a comment

Choose a reason for hiding this comment

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

Looks good!

I found one more instance of double quotes in TypeScript code.

docs/guide/your-first-scene.md Outdated Show resolved Hide resolved
Copy link
Contributor

@andretchen0 andretchen0 left a comment

Choose a reason for hiding this comment

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

Great! Approved.

@colinscz
Copy link
Contributor Author

colinscz commented Mar 7, 2024

@alvarosabu from my side this is ready to go - maybe you or @JaimeTorrealba have a quick look at the sentence in the light-shadows.md and if the meaning of it is correct after my update.

Copy link
Member

@JaimeTorrealba JaimeTorrealba left a comment

Choose a reason for hiding this comment

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

Thanks for this, for me is ready

@colinscz
Copy link
Contributor Author

colinscz commented Mar 7, 2024

Thanks for this, for me is ready

Great thanks for the feedback @JaimeTorrealba , then I resolve the remaining open threads. I just resolved the merge conflict so it would also be ready to merge from my side.

@alvarosabu alvarosabu merged commit b702e3b into Tresjs:main Mar 8, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Typos in docs
4 participants