griffithlab / griffithlab/civic-docs

Rename "CIViC Knowledge Model"

Open
#86 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
5
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Right now this section appears in the docs at the bottom above the API docs. The name and position in the list do not seem intuitive that this is where one goes to understand the information in CIViC.

How about something like this instead?

  • About CIViC
  • Using CIViC
  • CIViC Knowledge Model -> Understanding CIViC
  • Curating CIViC
  • CIViC API
  • Get Help

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Inspect the documentation navigation where “CIViC Knowledge Model” currently appears, then review the surrounding menu entries and their links. Rename that entry to “Understanding CIViC” and move it to the proposed position, verifying that the navigation renders correctly and existing links still work.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.