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

Revise the page title format for readability #1175

Open
3 tasks done
timng-bcgov opened this issue Sep 11, 2024 · 0 comments
Open
3 tasks done

Revise the page title format for readability #1175

timng-bcgov opened this issue Sep 11, 2024 · 0 comments
Labels
jira ux User experience

Comments

@timng-bcgov
Copy link

API Services Portal Issue

User Story

As an API provider or consumer ,

I want to understand the purpose of each page on the API Services Portal from the page title

so that I can configure Gateway services and consume APIs.

Test Case

ENV

  • DEV
  • TEST
  • PROD

TESTCASE

The <title> element defines the document's title that is shown in the browser's title bar or a page's tab.

EXPECTED

It is important to provide an accurate and concise title to describe the page's purpose. Page titles should be unique, surfacing the primary purpose of the page first, followed by the name of the website. This provides a better experience than having to read the name of a website before the unique page title, for every page a user navigates to in the same website.

Show the page title first, e.g. 'Gateway name | Gateways | API Program Services'

ACTUAL

The current title looks like this: 'API Program Services | Page'

For nested routes, the page title is easily hidden in the tab: 'API Program Services | Gateways | Gateway name'

image

Notes

There is a discrepancy between the title metadata on the API Directory as it reads 'API Services Portal | API Directory' whereas other pages on the Portal read 'API Program Services | X'. There should be a discussion on what our service(s) should be called before deciding on revising this.

@timng-bcgov timng-bcgov added ux User experience jira labels Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira ux User experience
Projects
None yet
Development

No branches or pull requests

1 participant