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 documentation typos and list rendering #6066

Merged
merged 4 commits into from
Mar 6, 2024
Merged

Fix documentation typos and list rendering #6066

merged 4 commits into from
Mar 6, 2024

Conversation

alex-mccarthy-unity
Copy link
Collaborator

Proposed change(s)

Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)

Sample mis-rendered list that this should fix can be found under https://unity-technologies.github.io/ml-agents/#releases-documentation

Types of change(s)

  • Bug fix
  • New feature
  • Code refactor
  • Breaking change
  • Documentation update
  • Other (please describe)

Checklist

  • Added tests that prove my fix is effective or that my feature works
  • Updated the changelog (if applicable)
  • Updated the documentation (if applicable)
  • Updated the migration guide (if applicable)

Other comments

I assume this extra blank line will fix the list not being correctly formatted on https://unity-technologies.github.io/ml-agents/#releases-documentation
Add a blank line before bulleted lists in markdown files to avoid them being rendered as in-paragraph sentences that all start with hyphens.
Copy link
Collaborator

@miguelalonsojr miguelalonsojr left a comment

Choose a reason for hiding this comment

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

LGTM.

@alex-mccarthy-unity alex-mccarthy-unity merged commit 4f2cfd1 into Unity-Technologies:develop Mar 6, 2024
8 checks passed
@alex-mccarthy-unity alex-mccarthy-unity deleted the readme-fixes branch March 6, 2024 13:59
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