Incomplete documentation for Core Modules and Cmfive Tests

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Review the menu structure in the documentation site to identify which core module links are missing. Locate the existing documentation files for Introduction, Insight, and Report to understand the format. Then, find or create the corresponding pages for the other core modules and the missing Cmfive Tests pages (Running Tests and Writing Tests). Ensure all new pages are properly linked in the menu.

Written by the indexing model from the issue text.

Description

The menu for Core Module documentation lists all of the core modules, however only the Introduction, Insight, and Report documentation pages have been linked. Cmfive Tests is mostly complete except for the Running Tests and Writing Tests documentation pages.

Dominant language
SCSS
Stars
0
Forks
1
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 2pisoftware/cmfive-docs

All issues in 2pisoftware/cmfive-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.