* Rename all GitHub links from thepracticaldev/dev.to to forem/forem
* Use new site name
* Rename to Forem
* Rename more dev.to to forem
* Remove unnecessary redirects
* Rename DEV to Forem
* Use Forem instead of DEV for branding
* Use Forem instead of DEV for licensing
* Use seedling instead of DEV logo
* Update contributing guide
In this change, I tried to simplify the language of the contributing
guide to make it more accessible and less wordy.
I also updated the information in a few places and fixed a couple of
typos.
* Remove table of contents
Since moving this doc to the docs site, our theme generates a ToC
automatically, hardcoding this one is redundant.
* Move the contributing guides
* Update maintainer documentation
This chnage updates the maintainers guide to include information on PR
reviews, deployments, and CI.
Housing this documentation here increases transparency with our
community.
* Edit with PR feedback
* Edit based on PR feedback
We are no longer using the Percy service, so this code is not required anymore.
Removes the percy agent, the gem, and all references to Percy.snapshot and percy: true.
* Remove skip-ci article from docs
Skipping CI causes a hiccup in the PR merging and approval process.
Molly and I talked about this, and we probably need to revisit our
github process revolving around this, but since it is presently causing
an issue, it probably shouldn't be in the docs. We can always add it
back if we change our minds.
* Add a maintainers doc
This doc will give us a place to store information, like the discussion
that Molly and I had around skipping CI, so that anyone with Repo access
can find and contribute to how we run the project.
It was unclear to me that I explicitly needed Elasticsearch in order for certain tests to run locally. We should specify that in the docs. Also added a note about installing `wget`, which is required to install Elasticsearch in our docs.
* Improve format and clarity of the docs [ci skip]
While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.
For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.
This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)
* Delegate markdown wrapping to Prettier
* Add linewrapping explanation in the docs [ci skip]
* Add jext-axe package and introduce a11y testing
Automated a11y testing is NOT comprehensive. We cannot expect this to
even scratch the surface of potential a11y issues.
However, we can expect to find a percentage of issues that are currently
flying under the radar. Adopting some automation around a11y testing
also allows us to use CI to find a11y regressions -- which should be
really handy.
I've never really used Jest before, and Preact seems to make it a little
more complicated, but as far as I can tell, this is a decent way to add
at least some minor automated a11y testing.
* Add doc about automated a11y tests
* Correct installation documentation
* Add stylized titles
* Add some changes to the getting started documentation
* Add changes for the backend guide
* Add changes for the design guide
* Add testing / Q&A guide improvements
* Minor fixes to contributing docs
* More improvements to the general doc
* Improvements for frontend guide
