FEATURE: Have a link for toplevel sections

Open Beginner friendly
#941 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Find the documentation page containing the “Installation and configuration” section and check how its subsections receive links. Add a linkable top level section, such as a list linking to those subsections. Done when readers can link directly to the overview of how to install or access EESSI.

Written by the indexing model from the issue text.

Description

While writing emails and documentations i've often found myself wanting to link to a toplevel How to install/access EESSI section which right now would be the Installation and configuration section in the doc.

Currently links are available only for its subsections, but i think it would be useful to introduce a top level sections (even a list with links to its subsection) that can be linked to for reporting

Dominant language
Python
Stars
14
Forks
54
Avg merge
11h 2m
Merged PRs (30d)
41

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 EESSI/docs

All issues in EESSI/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.