Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: README cleanup #2635

Open
2 tasks
SgtPooki opened this issue Sep 20, 2023 · 0 comments
Open
2 tasks

feat: README cleanup #2635

SgtPooki opened this issue Sep 20, 2023 · 0 comments
Labels
exp/beginner Can be confidently tackled by newcomers exp/novice Someone with a little familiarity can pick up help wanted Seeking public contribution on this issue need/community-input Needs input from the wider community need/maintainers-input Needs input from the current maintainer(s) P3 Low: Not priority right now topic/devexp Developer Experience

Comments

@SgtPooki
Copy link
Member

Our FAQ & Troubleshooting section is getting fairly large.

Let's follow the pattern in brew's repo with a main TROUBLESHOOTING.md and COMMON-ISSUES.md doc

There are also some other cleanup actions we can perform to make things a little more hospitable to our users.

Tasks
Preview Give feedback

Questions/Concerns:

  1. If we update troubleshooting to a new document, some existing links in issues (open and closed) will break. Are we okay with this?
  2. If we don't want to move troubleshooting/faq, how else can we clean things up?
@SgtPooki SgtPooki added the need/triage Needs initial labeling and prioritization label Sep 20, 2023
@SgtPooki SgtPooki mentioned this issue Sep 20, 2023
Merged
@github-project-automation github-project-automation bot moved this to Needs Grooming in IPFS-GUI (PL EngRes) Sep 21, 2023
@whizzzkid whizzzkid added help wanted Seeking public contribution on this issue exp/novice Someone with a little familiarity can pick up P3 Low: Not priority right now need/maintainers-input Needs input from the current maintainer(s) need/community-input Needs input from the wider community exp/beginner Can be confidently tackled by newcomers topic/devexp Developer Experience and removed need/triage Needs initial labeling and prioritization labels Sep 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
exp/beginner Can be confidently tackled by newcomers exp/novice Someone with a little familiarity can pick up help wanted Seeking public contribution on this issue need/community-input Needs input from the wider community need/maintainers-input Needs input from the current maintainer(s) P3 Low: Not priority right now topic/devexp Developer Experience
Projects
No open projects
IPFS-GUI (PL EngRes)
Status: Needs Grooming
Milestone
No milestone
Development

No branches or pull requests
2 participants
@SgtPooki @whizzzkid