Standard navigation between about/reference/guide

Open
#702 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
html
Domain
documentation

Research direction

Start by reviewing the existing about, reference, and guide pages and how their introductions currently cross-link related topics. Define a single navigation pattern that works across these page types; done means the approach is documented and consistently applied wherever a topic has multiple page types.

Written by the indexing model from the issue text.

Description

navigation

When we have pages for a topic across multiple page types, there is no standard way of cross-linking them. It's usually done in the intro in a variety of ways. Should consider adding a standardized navigation for that (left nav, right nav, top of page).

Dominant language
HTML
Stars
259
Forks
275
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from clojure/clojure-site

All issues in clojure/clojure-site

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.