Commit Graph

37 Commits

Author SHA1 Message Date
Stephen Kirby 91a8b1b886
chore: fix broken docs links (#11760)
* fixed broken install/packages.md link

* fixed broken docs links

* fixed admin/auth link

* fixed example-guide links

* replaced mitchell tweet with nix docs

* make fmt

* replaced private image with imgur
2024-01-22 18:45:34 -06:00
Eric Paulsen 6715cb6a95
docs: resolve README 404s (#7822) 2023-06-02 20:56:06 +00:00
Muhammad Atif Ali 4061a254a5
docs: fix a broken link in docs/README.md (#7150) 2023-04-17 13:05:12 +00:00
Muhammad Atif Ali 0e50afe4cf
fix(docs): fix broken docs (#7138)
* fixing a lot of broken links

* more fixes

* add 0 as valid status codes

https://tools.ietf.org/html/rfc7231#section-6.3.1 --> 0 as status code
2023-04-14 11:11:51 -05:00
Bruno Quaresma de66f0d540
docs: Add frontend guide (#5852) 2023-01-25 16:15:06 +00:00
Ammar Bandukwala 05dc83e522
docs: add hero image to About (#5539)
A reddit comment recently linked to this page, so we want to
make it convert better.
2023-01-02 14:36:36 -06:00
sharkymark 461c0d0d39
docs: v1 docs redirect (#5509)
* docs: v1 docs redirect

* fix link

Co-authored-by: Ben <me@bpmct.net>
2022-12-22 15:14:36 -08:00
Marcin Tojek cec667d309
fix: prettier misses docs directory (#5285)
* chore: keep admin/prometheus.md if make target fails

* Address PR comments

* Formatted

* fix: prettier misses docs

* make fmt

* More md files
2022-12-05 12:21:09 +01:00
Michael Eanes 126d71f41d
Remove alpha warning from about (#3774)
The doc was outdated; I don't think the software is alpha anymore.
2022-08-31 03:23:56 +00:00
Roman Zubov a21a6d2f4a
docs: replaced manual up next blocks with doc tag in workspaces.md (#3023)
* docs: replaced manual up next blocks with doc tag in workspaces.md

* replaced up next blocks with <doc page=""> tags

* revert back to markdown

now that we updated how these links work, we can have them as markdown on github and as cards on the docs website.

Co-authored-by: Anton Korzhuk <antonkorzhuk@gmail.com>
2022-08-25 08:26:04 -07:00
whitney-coder d6351a6b9f
Update README.md (#3539)
Minor grammatical change on line 14
2022-08-17 14:48:41 -05:00
Katie Horne 407c47fd65
chore: change Coder v2 to Coder OSS in docs (#2630) 2022-06-27 11:07:17 -05:00
Katie Horne 4eda7034ee
chore: fix broken links to use full path (#2606) 2022-06-23 09:04:31 -05:00
Katie Horne f476a4ad37
chore: fix broken links and formatting issues (#2547) 2022-06-21 13:13:38 +00:00
Katie Horne f5e558c4ec
chore: convert citations to hyperlinks (#2392) 2022-06-15 16:11:44 -05:00
Ammar Bandukwala 2e625c1d9b
docs: use about as home page (#2382)
* docs: use About as home page

* docs: format install.md
2022-06-15 14:03:13 -05:00
Katie Horne cbde8e8b91
chore: add hero image to OSS docs homepage (#2241) 2022-06-13 09:16:26 -05:00
Bruno Quaresma d04d527f2c
chore: Update docs manifest home page and icons (#2133)
* chore: Update docs manifest home page and icons

* RRemove contributors

* Update template icon

* fixup: manifest.json changes

* fix: add missing readme to root

* fix: add readme to /docs with toc

* fix: add quickstart to manifest

Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-06-09 18:46:16 +00:00
Joe Previte 0622603220
docs: move README to root (#1630)
We noticed that when you download the repo as a ZIP from GitHub, it
places the `README.md` in the root, which causes the relative links to
break.

By moving it to the root, this will fix that issue.
2022-05-20 09:56:50 -07:00
Katie Horne 6f969214d3
chore: validate docs (#1485) 2022-05-19 08:01:19 -05:00
Ben Potter b8ee939e52
chore: change Slack to Discord link (#1573) 2022-05-18 21:14:31 +00:00
Eric Paulsen 695b709173
fix: examples link in README (#1441) 2022-05-13 16:43:10 -05:00
Ben Potter 64a8b4ac47
chore: add bpmct to contributors list (#1332) 2022-05-13 02:01:31 +00:00
G r e y 9ef64fd192
chore: add myself as a contributor (#1408) 2022-05-12 14:44:54 -04:00
Spike Curtis c96d439f3d
chore: add Spike Curtis to contributors (#1333)
Signed-off-by: Spike Curtis <spike@coder.com>
2022-05-10 16:46:28 +00:00
Ben Potter e8e4cf9a37
feat: add comparison to docs (#1315)
* fix typo

* feat: add comparison table

* Update docs/about.md

Co-authored-by: Katie Horne <katie@23spoons.com>

* Update docs/about.md

Co-authored-by: Katie Horne <katie@23spoons.com>

* Update docs/about.md

Co-authored-by: Katie Horne <katie@23spoons.com>

* chore: remove gitpod

Co-authored-by: Katie Horne <katie@23spoons.com>
2022-05-10 16:31:59 +00:00
David Wahler d847d2b1c5
chore: add dwahler as contributor (#1352) 2022-05-09 20:57:03 +00:00
Kira Pilot f5693dff3d
chore: added contributer (#1349) 2022-05-09 14:49:23 -04:00
Ben Potter f965066517
feat: add screenshot to readme (#1313)
* feat: add screenshot to readme

* change
2022-05-06 01:09:27 +00:00
Kyle Carberry c2b5009208
fix: Unnest workspaces command to the top-level (#1241)
This changes all "coder workspace *" commands to root.
A few of these were already at the root, like SSH. The
inconsistency made for a confusing experience.
2022-05-02 11:08:52 -05:00
Mathias Fredriksson 0b1ee3303d
chore: Add Contributors section to readme (#1144)
Co-authored-by: Cian Johnston <public@cianjohnston.ie>
2022-04-27 11:48:45 +00:00
Ben Potter 22668c388c
feat: initial docs pages (#1107)
* docs structure and edits to getting started

* draft for about page

* skeleton for concepts page

* attempt at explaining templates

* left-align tables

* add best practices and variables

* update structrure

* update structure

* templates are shared

* workspaces docs

* remove coming soon

* fix typos

* docs structure and edits to getting started

* draft for about page

* skeleton for concepts page

* attempt at explaining templates

* left-align tables

* add best practices and variables

* update structrure

* update structure

* templates are shared

* workspaces docs

* remove coming soon

* fix typos

* fix typos

* Update docs/about.md

Co-authored-by: Joe Previte <jjprevite@gmail.com>

* remove line breaks between bullets

* rename variables to parameters

* reduce limits

* chore: edit text

* revert some changes, fix footnotes

Co-authored-by: Katie Horne <katie@coder.com>
Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-04-26 12:10:50 -05:00
Kyle Carberry 3976994781
chore: Rename "start" to "server" (#1110)
Workspace commands will be aliased at the top-level, so
"start" would easily be confused with starting a workspace.

Server seems like a more appropriate name too.
2022-04-23 12:19:20 -05:00
Ben Potter b7d7e19606
fix: rename projects to templates in README (#920) 2022-04-07 17:58:17 -04:00
Joe Previte 584c8b4fc3
docs: move development workflow to CONTRIBUTING (#890) 2022-04-06 10:26:17 -07:00
Kyle Carberry 1e9e5f7c76
chore: Add contributing guidelines (#874)
It's helpful for us Coders to align on a common set of style
guidelines. While I'd prefer to automate this, documentation
should get us a lot of the way there!

Please review these thoroughly, as PRs will be checked against it
after merge.
2022-04-05 15:02:28 -05:00
Joe Previte f02b8fda9e
docs(README): move to /docs folder (#871) 2022-04-04 15:48:22 -07:00
Renamed from README.md (Browse further)