Improve readme about actions-wiki HOT 5 CLOSED

I went with "... to a GitHub wiki"

The reason is that, with the correct access for a token and the repository input, you can publish to any repo's wiki, such as from your personal repo to an org.

from actions-wiki.

📖 most resembles GitHub's Wiki icon, so I think I'll go with that. Thanks for the suggestions!

from actions-wiki.

My personal philosophy is to keep the README as readable as possible in plain-text. In fact, I think Markdown is generally a great guideline for making readable plain-text. There's also accessibility to consider -- ideally, the README should render to something that screen-readers can use.

I've never formally defined these self-imposed rules, but here's a basic idea:

• Images are cool, but shouldn't be required for reading and understanding the docs. Frequently used badges, like CI badges, are an exception.
• Little to no HTML in the Markdown. READMEs with <p align="center"> definitely look prettier when rendered, but I think it harms plain-text readability.
• Text styling should be used semantically. E.g. ## header isn't just a way to make big, eye-catching text, but to define a section, which is helpful for screen-readers.

That's pretty much all I can think of off the top of my head. I wouldn't worry too much about it -- we can discuss the trade-offs between plain-text readability and rendered prettiness further 🙂

from actions-wiki.

Add an emoji to the description

BTW I'm totally up for an emoji, if you have any suggestions 😆

from actions-wiki.

BTW I'm totally up for an emoji, if you have any suggestions 😆

I think one of these: 📚📕📖📘📜 fits the idea of a "docs" sort of emoji. For the description I used this in the readme draft #13

📖 Deploy docs from your source tree to the GitHub wiki

now that I read it again that "the" should be "your"

📖 Deploy docs from your source tree to your GitHub wiki

ill have to fix that in my pr

from actions-wiki.