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 broken links in docs #1638

Merged
merged 1 commit into from
Jun 9, 2021
Merged

Fix broken links in docs #1638

merged 1 commit into from
Jun 9, 2021

Conversation

KyrietS
Copy link
Member

@KyrietS KyrietS commented Jun 1, 2021

What does this PR do?

Fix broken links in docs (#1634)

How does this PR change Premake's behavior?

no

Anything else we should know?

  • I've added some additional information to website/README about referencing other pages in docs.

Adding a reference to another documentation page

Always reference another documentation page like this:

[some text](Case-Sensitive-Filename.md)

and never like this:

[some text](some-markdown-file)
[some text](/docs/some-markdown-file)
[some text](https://premake.github.io/docs/some-markdown-file)

closes #1634

Did you check all the boxes?

  • Focus on a single fix or feature; remove any unrelated formatting or code changes
  • Add unit tests showing fix or feature works; all tests pass
  • Mention any related issues (put closes #XXXX in comment to auto-close issue when PR is merged)
  • Follow our coding conventions
  • Minimize the number of commits
  • Align documentation to your changes

You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to requests like these!

website/docs/Building-Premake.md Show resolved Hide resolved
@@ -7,7 +7,7 @@ title: Debugging Scripts
Since Premake's update to 5.3, the only debugger that seems to be able to debug Premake is the free ZeroBrane Studio IDE.
Copy link
Member

Choose a reason for hiding this comment

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

Unrelated, but we should update wording like this. It reads more like a community review, than a statement from the development team. @starkos

@KyrietS KyrietS requested a review from starkos June 8, 2021 16:36
Copy link
Member

@starkos starkos 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 taking care of this!

@starkos starkos merged commit ea92474 into premake:master Jun 9, 2021
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.

Broken links to some pages in docs
3 participants