* Add gitdocs add a devDependency
* Update docs to use local gitdocs installation
* Apply suggestion
Co-authored-by: Nick Taylor <nick@iamdeveloper.com>
* Apply suggestion
Co-authored-by: Nick Taylor <nick@iamdeveloper.com>
* Fix other places where gitdocs is mentioned
* Revert to old Makefile
Co-authored-by: Nick Taylor <nick@iamdeveloper.com>
* 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
* Move contributing guide to the docs
I think it makes sense to address this information on the docs site, but
I also think the CONTRIBUTING.md convention is important.
In order to avoid duplicating the documentation for contributors, I
think it is a good idea to link people from the repo's contributing
guide to a document on the documentation site.
* Document difficulty labels
* Use Forem in place of DEV
* 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.
* 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]
The readme should include instructions to run the docs site so that
people don't have to go searching for the contributing.md file if they
are stumbling upon the docs in their code editor instead of via the
docs.dev.to website.
* 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
* Added prettier for markdown files on precommit.
* Ran prettier on markdown files.
* Fixed wording as per PR comment.
* Got rid of the double vision on "the". 🙃
* Rename and add addl postgres setup
* Update ToC for docs/readme
* Add links + enrich license FAQ page (#671)
- Added brief "intro" section at the top
- Added back in links that were lost in copy/paste over
* Nick/task/update front end docs [skip ci]
* Clarify that each step is an or
* issue/pr templates
* Remove broken redirect from netlify
* Attempt to add redirects for Netlify
* Try to fix redirects for Netlify
* Added more redirects for netlify
* Fix redirects to use splat keyword
* Testing placeholder instead of splat
* add product roadmap
* Change doc contribution instructions
* Add notice at bottom
* Move frontend doc [ci skip]
* Fix DEV styling [ci skip]
* Update table of contents [ci skip]
* Move stuffs around [ci skip]
* Move stuffs around [ci skip]
* Add gitdocs integration
* Mess with title again [ci-skip]
* Add root readme back in
* Update docs/readme as a new readme
* Messing with title again
* Add where to get help [ci skip]
* Fix dev connect link [ci skip]
* Move how to get help [ci skip]
* Add TODO to empty headers
* Add more TODOs and clean up a link
* Add sloan
* Update prereqs to specify we use macOS
* Add gitdocs build to test on Netlify
* Update README [ci skip]
* Add .gitdocs_build/ to .gitignore [ci skip]
* Create netlify.toml
* Update docs with logo and more docs
* Update gitdocs name
* Add redirects for netlify
* Remove extraneous redirects from netlify
* Add more README TODOs [ci skip]
* Update root directory of gitdocs
* Move ISSUE_TEMPLATE to .github/ [ci skip]
* Testing new base for netlify
* Update README [ci skip]
* Rename index.md to readme.md for GitHub
* Move gitdocs.json to docs folder
* Add GPL LICENSE [ci skip]
* tweak readme
* update license language
* Update FAQ with some Q and A
* Add some traffic control for docs readme
* add license faq and core team members
* Add new line to fix list
* Add AGPL-3
Adding the GNU AFFERO GENERAL PUBLIC LICENSE.
* Update GPL License
* Additional documentation for PostgreSQL setup
