Skip to content

docs(other): add information from realm/navigation, fix issues#327

Open
JLekawa wants to merge 7 commits into
mainfrom
23388-docs-add-removed-navigation-content-to-end-user-docs
Open

docs(other): add information from realm/navigation, fix issues#327
JLekawa wants to merge 7 commits into
mainfrom
23388-docs-add-removed-navigation-content-to-end-user-docs

Conversation

@JLekawa

@JLekawa JLekawa commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What/Why/How?

Adds information that was removed from docs/realm/nagivation.

Fixes formatting.

Reference

Closes #23388

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@JLekawa JLekawa requested a review from adamaltman July 2, 2026 06:27
@JLekawa JLekawa self-assigned this Jul 2, 2026

@redocly redocly Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

marketing-site AI Review: 🟢 Completed

Reunite Agent has reviewed your changes and found 7 potential issue(s).

Note

Low Risk

This PR contains purely documentation updates and Markdown formatting fixes, posing no risk to application behavior or operational stability.

Overview

Updates end-user documentation to include missing navigation details and fix formatting issues. Key changes include:

  • Adding mobile navigation instructions with an accompanying hamburger menu icon image.
  • Expanding documentation to include details about page footers and previous/next navigation buttons.
  • Correcting Markdown numbered list formatting and code block indentation in various guides (API interaction, search, and CLI testing).

Comment thread docs/end-user/navigate-project.md Outdated
Comment thread docs/end-user/navigate-project.md Outdated
Comment thread docs/end-user/navigate-project.md Outdated
Comment thread docs/end-user/navigate-project.md Outdated
Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com>
@JLekawa JLekawa changed the title docs(other): add information realm/navigation, fix issues docs(other): add information from realm/navigation, fix issues Jul 2, 2026
Comment thread docs/end-user/navigate-project.md Outdated
Comment thread docs/end-user/navigate-project.md
Comment thread docs/end-user/navigate-project.md Outdated
Comment thread docs/end-user/navigate-project.md Outdated
withLightbox=true
/%}

1. Under the **Version** heading, select a version from the drop-down list.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Severity: Medium

The version picker is located above the sidebar. On mobile, the slide drawer usually displays the sidebar by default. Instructing users to select 'Main menu' (which contains navbar items) to find the version picker is likely incorrect.

Comment thread docs/end-user/navigate-project.md
Comment thread docs/end-user/navigate-project.md Outdated
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.

1 participant