wso2 / wso2/docs-api-platform

[Improvement]: Architecture diagrams on the Overview page affect first impression for new developers

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

Nobody has claimed this yet.

Type/Improvement
Dominant language
HTML
Stars
2
Forks
64
Avg merge
1d 9h
Merged PRs (30d)
34

Description

Current Limitation

The architecture diagrams on the Overview page look like AI-generated, not designed by hand. I think since this is usually the first page a developer lands on, that look brings down the first impression.

Suggested Improvement

I'm not part of the WSO2 team, so I wanted to ask first: would it be okay if I propose a PR with a hand-made diagram that matches the existing design style used across WSO2 docs? Let me know if this is something you'd be open to before I put in the work.

Version

No response

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

Review the architecture diagrams on the Overview page and compare them with the existing WSO2 documentation design style. Done means a hand-made replacement proposal is agreed on and matches that style; the issue does not name files, tests, or a more specific acceptance criterion.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
design, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.