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.

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

Missing a GitHub issue form template for docs issues #2583

Open
1 task done
JoshuaKGoldberg opened this issue Nov 6, 2024 · 2 comments
Open
1 task done

Missing a GitHub issue form template for docs issues #2583

JoshuaKGoldberg opened this issue Nov 6, 2024 · 2 comments

Comments

@JoshuaKGoldberg
Copy link

What version of starlight are you using?

n/a

What version of astro are you using?

n/a

What package manager are you using?

n/a

What operating system are you using?

n/a

What browser are you using?

n/a

Describe the Bug

I'd like to suggest some additions to docs, but the only template I can use is 🐛 Bug Report. Could we have a template for https://starlight.astro.build docs suggestions, please?

Filing as a bug report issue as suggested on Discord: https://discord.com/channels/830184174198718474/1070481941863878697/1303808425943236608

Link to Minimal Reproducible Example

n/a

Participation

  • I am willing to submit a pull request for this issue.
@delucis
Copy link
Member

delucis commented Nov 7, 2024

Could we have a template for starlight.astro.build docs suggestions, please?

Sure! Seems like a good idea to me.

Although I might suggest a distinction based on how we use the Starlight bug tracker:

  1. An issue template for errors/problems with docs
  2. A discussion template for new docs content suggestions

So I guess that’s two new things 😁

Basically, a while back we moved to using GitHub issues exclusively for bug reports, moving feature requests to discussions and I love having that distinction. A feature request might be a good idea but still take 2 years to get to sometimes and I found having those long-lived ideas gathering feedback alongside more urgent bug reports was difficult to manage. It lets us have a really clear “bugs” inbox of stuff to fix while still letting people share ideas that may take longer to get to (or require more community feedback).

So I think a similar distinction between “SOMETHING IS WRONG IN DOCS!” and “Hey, I would have loved to have a guide about X” would be good here too.

Are you interested in making a PR proposing these templates to kick things off?

@JoshuaKGoldberg
Copy link
Author

I really like that distinction, yeah! +1

Is it ok if I take a step back and not send the PR? It seems to me like you have a pretty solid idea of what you want. My hunch is I'd have to get a few rounds of PR review to get there. 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants