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

More code blocks added to the documentation + some spelling/minor fixes #35

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

Conversation

ReallyNewb
Copy link

@ReallyNewb ReallyNewb commented Feb 25, 2025

More code blocks added to the documentation + some spelling/minor fixes

My pull request is to

  • Add documentation
  • Fix documentation

If adding documenation, I am adding it to

  • Code blocks
  • Objects
  • Guides

If adding documentation, did I

  • Correctly format the page to match the other ones
  • Add it to the index page for the correct category
  • Add it to SUMMARY.md

Additional information

Just making the documentation a little less outdated. Just wanted to submit a pull request just in case. You can make as many changes as you want.

@ReallyNewb
Copy link
Author

If there are some block(s) that had a mistake in their .md file, please reply to me with them back. I know there are multiple blocks missing, but it's hard to keep up with the demand when you're only one person.

@FloofyPlasma
Copy link
Member

Hi thanks for contributing, I'll take some time to review.

@ReallyNewb
Copy link
Author

Making some, or like, 1 quick revision(s) right now. I should've checked for some stuff, but I'll make sure to see your feedback soon.

@ReallyNewb ReallyNewb changed the title More block codes added to the documentation More code blocks added to the documentation + some spelling/minor fixes Feb 25, 2025

## Description

Displays a colored chat bubble on a part object, with the specified message.
Copy link
Member

Choose a reason for hiding this comment

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

This should match the block description.

@@ -0,0 +1,58 @@
---
description: Displays a colored chat bubble on a part object, with the specified message.
Copy link
Member

Choose a reason for hiding this comment

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

This should match the block description.

@@ -0,0 +1,58 @@
---
description: Finds a path between the two positions. Returns a table of Vector3s, or a table with no elements if the path couldn't be computed.
Copy link
Member

Choose a reason for hiding this comment

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

This should match, or be part of the block description.


## Description

Finds a path between the two positions. Returns a table of Vector3s, or a table with no elements if the path couldn't be computed.
Copy link
Member

Choose a reason for hiding this comment

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

This should match, or be part of the block description.

@@ -0,0 +1,53 @@
---
description: Deals damage to a character if they are not protected by a ForceField.
Copy link
Member

Choose a reason for hiding this comment

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

This should match, or be part of the block description.

Copy link
Member

Choose a reason for hiding this comment

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

Missing property input.

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 break this into client/server side specifically.

@@ -30,7 +30,7 @@ Runs the blocks connected to it when the given player starts holding down their

#### Player (Object)

You give the path to a Player.
You give the path to a Player. *This input is only reserved for server scripts.*
Copy link
Member

Choose a reason for hiding this comment

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

Can you rewrite this and remove the pronouns

Copy link
Member

Choose a reason for hiding this comment

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

Remove your comments, make a bug report in the support server instead.

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