Refresh Documentation Website

Open
#2,072 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Active
Domain
documentation

Research direction

Start by reviewing the existing documentation website and comparing its new-user experience with Ratel's, as the issue suggests. The issue does not identify specific files, pages, or tests, and leaves the desired changes open-ended; first clarify the goals and scope with the maintainers. Done means the documentation website has an agreed, more new-user-friendly direction and the resulting changes are reviewed.

Written by the indexing model from the issue text.

Description

documentation

The documentation website isn't a new-user-friendly as Ratel's. We should revisit and think about how we want it to look.

Dominant language
C
Stars
273
Forks
84
Avg merge
1d 15h
Merged PRs (30d)
21

Getting set up

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 CEED/libCEED

All issues in CEED/libCEED

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.