lundegaard / lundegaard/react-union.org
Simplify the navigation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
## Before implementation
Top navigation bar:
- Documentation
Left bar:
- Union component
- ...
- Scripts
- ...
- Boilerplates
- ...
## After implementation
Top navigation bar:
- Union component
- Scripts
- Boilerplates
Left bar - corresponding to top section.
E.g. when scripts are selected:
- Installation
- Introduction
- ...
- Recipes
- recipe 1
- recipe 2
- ...
## Motivation
This should make nested documented features more visible. E.g. Recipes section from Scripts category.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation site's navigation entry point and reviewing how the current top and left bars are assembled. Restructure the navigation so Union component, Scripts, and Boilerplates are top-level sections with corresponding nested content visible in the left bar; verify that selecting Scripts exposes sections such as Installation, Introduction, and Recipes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100