Skip to content

Revise sidebar structure, labels, and frontmatter for usability and discoverability#449

Merged
MohabMohie merged 3 commits into
masterfrom
copilot/revise-side-menu-structure
Apr 8, 2026
Merged

Revise sidebar structure, labels, and frontmatter for usability and discoverability#449
MohabMohie merged 3 commits into
masterfrom
copilot/revise-side-menu-structure

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 8, 2026

The sidebar had vague category names, illogical ordering, and missing SEO metadata — making navigation harder for both humans and search crawlers.

Sidebar restructure (sidebars.js)

  • Merged "Basic Configuration" + "Properties" into a single "Configuration" category (ordered: Property Types → Web/Mobile/API config → Parallel Execution → Common Examples → Properties Reference → Programmatic Config)
  • Renamed categories for clarity: ActionsKeywords & Actions, GUIWeb / GUI, APIREST API, CLICLI / Terminal, DBDatabase, Project Setup GuidesProject Setup
  • Renamed "Did You Know" → "Advanced Topics" and regrouped its 19 items into logical clusters: locator strategies → browser/element control → grid & cloud → testing capabilities → integrations
  • Reordered Best Practices into a learning progression: Architecture → Testing Pyramid → Tool Selection → Solution Design → Test Structure → Fluent Design → Element Identification → Cross-Platform → BDD Reports → Cucumber → CI/CD → Test Artifacts
  • Promoted "Soft vs Hard Assertions" to second in Validations (right after Overview — it's foundational)

Frontmatter fixes

  • Added tags: to 11 Best Practices pages that had none — enables search tag-boost and improves crawlability
  • Fixed vague sidebar_label values on 7 pages: TypesProperty Types, ListProperties Reference, ExamplesCommon Examples, BuilderRequest Builder, ParsingResponse Parsing, ValidationsResponse Validations, ActionsDatabase Actions

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 8, 2026

Deploy Preview for shaftengine ready!

Name Link
🔨 Latest commit 05e1301
🔍 Latest deploy log https://app.netlify.com/projects/shaftengine/deploys/69d633a2882bdc0008109b94
😎 Deploy Preview https://deploy-preview-449--shaftengine.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 90
Accessibility: 93
Best Practices: 92
SEO: 100
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

- Merge Basic Configuration + Properties into single Configuration category
- Rename Actions→Keywords & Actions, GUI→Web/GUI, API→REST API, CLI→CLI/Terminal, DB→Database
- Rename Project Setup Guides→Project Setup, Did You Know→Advanced Topics
- Reorder Advanced Topics items by topic group (locators, browser control, grid, testing, integrations)
- Reorder Best Practices in logical learning progression
- Move Soft vs Hard Assertions to second position under Validations
- Add tags frontmatter to 11 Best Practices pages
- Fix vague sidebar_labels: Types→Property Types, List→Properties Reference, Examples→Common Examples, Builder→Request Builder, Parsing→Response Parsing, Validations→Response Validations, Actions→Database Actions

Agent-Logs-Url: https://github.com/ShaftHQ/shafthq.github.io/sessions/c86ecf35-b460-4c85-91ad-b7ce57c18bc5

Co-authored-by: MohabMohie <19201898+MohabMohie@users.noreply.github.com>
Copilot AI changed the title [WIP] Revise side menu for better usability and organization Revise sidebar structure, labels, and frontmatter for usability and discoverability Apr 8, 2026
Copilot AI requested a review from MohabMohie April 8, 2026 10:00
Signed-off-by: Mohab Mohie <Mohab.MohieElDeen@outlook.com>
@MohabMohie MohabMohie marked this pull request as ready for review April 8, 2026 10:53
@MohabMohie MohabMohie merged commit 825f22f into master Apr 8, 2026
6 of 7 checks passed
@MohabMohie MohabMohie deleted the copilot/revise-side-menu-structure branch April 8, 2026 10:53
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.

Revise the list, double check that the recent implementation covers the needed scope. Create a new ticket if needed to follow-up on missing items

2 participants