moja-global / moja-global/moja_global_docs

Improving the copyright section under Read the Docs

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

Nobody has claimed this yet.

Dominant language
Shell
Stars
35
Forks
64
PR merge metrics
No merged PRs in 30d

Description

What does the current documentation state?
The footer element houses a copyright text stating no name for the organisation. This may look unprofessional to many. Also there is no automatic date updation for the current year.

Where is this stated?
This is stated under the official developer documentation.

Why do you want to improve the statement?
I want to improve the statement so that it looks professional to the users.

Proposed statement
I have made a PR for the same and if any changes are to made, feel free to discuss them :)

CC: @Tlazypanda @aornugent @gmajan

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.

Research direction

Start from the footer on the linked Read the Docs developer documentation page and locate the corresponding documentation source or theme configuration. Done means the copyright statement names the organisation and updates automatically to the current year; the issue says a pull request was already made, so check its status first.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.