patternfly / patternfly/react-topology
Model hyperlink in README points to invalid page
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Describe the problem
The URL to the Model in the basic usage is outdated and doesn't point to any file.
How do you reproduce the problem?
- Go to basic usage README
- Select the "Model" hyperlink.
Expected behavior
The hyperlink should take me to the appropriate place in code. Possibly https://github.com/patternfly/react-topology/blob/main/packages/module/src/types.ts
What is your environment?
-
OS: [Fedora 38]
-
Browser [Firefox]
Jira Issue: PF-2003
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the basic usage section of the README and follow the current Model hyperlink to confirm that it is invalid. Check the proposed packages/module/src/types.ts location, update the README link to the appropriate TypeScript definition, and verify that the rendered link reaches an existing file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100