Skip to content

DOC: Refactor and Update Documentation for Clarity and Accuracy #461

@rohan-pandeyy

Description

@rohan-pandeyy

What's wrong with the existing documentation

The current state of the PictoPy documentation website has several outdated links, incorrect references, and formatting issues that can hinder new contributors and users.

Goal:

Address the inconsistencies to improve the overall clarity and accuracy of the project's documentation.

Tasks:

  1. Update setup page README.md link to directly link to the CONTRIBUTING.md file instead.
  2. Clean up invalid links inside homepage
  3. Format Overview page to enhance readability.
  4. Update Technical Stack table to match the one in README.md

Add ScreenShots

Image Image Image

Record

  • I agree to follow this project's Code of Conduct
  • I want to work on this issue

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions