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:Update index.md #1952

Merged
merged 6 commits into from
Jun 27, 2024
Merged

DOCS:Update index.md #1952

merged 6 commits into from
Jun 27, 2024

Conversation

Donal-Power
Copy link
Collaborator

Fixing typo to resolve docf-4184

Description

Fixed user reported bug in documentation

Changes made

Fixed typo to resolve docf-4184

Testing

None - Docs-only change

Risk

None - Docs-only change

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

After merge:

  • Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

Fixing typo to resolve docf-4184
@Donal-Power Donal-Power requested review from ekcoh and duckets June 20, 2024 14:06
@Donal-Power Donal-Power changed the title Update index.md DOCS:Update index.md Jun 20, 2024
Copy link
Collaborator

@ekcoh ekcoh 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 the contrib. LGTM. Normally we also add an appropriate message to CHANGELOG.md, but for this small correction I think it's ok to omit it, mainly fixing some typos.

@ekcoh ekcoh mentioned this pull request Jun 27, 2024
4 tasks
@ekcoh ekcoh merged commit dddce7d into develop Jun 27, 2024
77 of 79 checks passed
@ekcoh ekcoh deleted the docf-4184 branch June 27, 2024 17:13
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.

3 participants