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

Change default folder to wiki #57

Closed
wants to merge 8 commits into from
Closed

Change default folder to wiki #57

wants to merge 8 commits into from

Conversation

jcbhmr
Copy link
Contributor

@jcbhmr jcbhmr commented Apr 13, 2023

⚠️ this is a breaking change.... BUT i think that's ok since we are still at v0 with specific tags i.e. no risk of a v0.2 (which doesn't exist btw) suddenly breaking

this PR would... checkboxes track draft

  • change readme option text to match
  • change action.yml default value
  • change action.yml text
  • OPTIONAL: change example to be non-default? like "my-wiki" or something?
  • move test folder from .github/wiki to wiki/

discussed in #33

biggest proponent:

a point in favor of wiki vs .github/wiki is its prevalence in existing repos and the convention of where wiki docs are put: 137,000 in /wiki/**.md vs 154 in /.github/wiki/**.md -- pretty stark difference 🤪

@jcbhmr jcbhmr marked this pull request as ready for review April 13, 2023 20:08
the dir didn't exist that's why it kept failing before
@jcbhmr
Copy link
Contributor Author

jcbhmr commented Apr 13, 2023

@spenserblack ready for review

@jcbhmr jcbhmr mentioned this pull request Apr 13, 2023
@jcbhmr jcbhmr mentioned this pull request Apr 19, 2023
4 tasks
@spenserblack
Copy link
Owner

I think perhaps we should see what other users do. Do they often override the default folder to be /wiki/? I have a weirdly strong opinion about .github/wiki, but I'll change my mind if I'm obviously outvoted 🙂

@jcbhmr
Copy link
Contributor Author

jcbhmr commented May 24, 2023

I can tell this is going nowhere with #81 in progress 😅

@jcbhmr jcbhmr closed this May 24, 2023
@jcbhmr jcbhmr deleted the patch-1 branch May 24, 2023 03:46
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

Successfully merging this pull request may close these issues.

2 participants