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

Consolidate HttpEnabled explaination #1014

Merged
merged 4 commits into from
Feb 5, 2025
Merged

Conversation

Superburke
Copy link
Contributor

Changes

The HttpService page currently provides multiple explainers of HttpEnabled - but none under the HttpEnabled property. I've spoken to a few people who have found this confusing, particularly when being linked into this page and missing the summary at the top (especially given that the sub-heading for 'Enable HTTP requests' does not show on the 'On This Page' right-hand navigation.

This PR consolidates the explanation on the page under the HttpEnabled property, linking down to it from the summary.

If this PR is merged, then the code samples on this page should also be updated to just link to the HttpEnabled property as a single source-of-truth explainer. For example, the astronaut sample currently contains an explanation that doesn't consider setting with command bar, whilst the Pastebin and RequestAsync samples do not mention enabling requests at all.
(obviously I can't currently update the samples as they're not present on repo!)

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

@Superburke Superburke requested a review from a team as a code owner February 5, 2025 19:21
@github-actions github-actions bot added the engine reference Changes the Engine API Reference documentation label Feb 5, 2025
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hi @Superburke, thanks so much for helping improve the Roblox creator documentation! Our technical writing team will review your pull request soon. In the meantime, please ensure you've read through the README.md, contribution guidelines, and style recommendations.

@IgnisRBX IgnisRBX merged commit 230aef0 into Roblox:main Feb 5, 2025
3 checks passed
@Superburke Superburke deleted the patch-1 branch February 5, 2025 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engine reference Changes the Engine API Reference documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants