Commit Graph

21 Commits

Author SHA1 Message Date
HermanPerkins
4fc5a69b6b
Directly explain how to find VSCode (#692)
* Directly explain how to find VSCode

Added "To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings." At the intro of both colors and shapes section.

* Update docs/user/README.md

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
2022-05-31 12:15:22 +01:00
Pokey Rule
972cab1594
Clarify introduction in main user README (#702) 2022-05-27 14:06:40 +02:00
Pokey Rule
ad177d9115
Add link to list of supported languages to README (#683)
* Add link to list of supported languages to README

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-05-19 17:50:32 +01:00
Pokey Rule
e4a3b9c4b8
More docs clarifications (#659) 2022-04-27 10:12:42 +01:00
Pokey Rule
2d1a3443db
More docs improvements (#658)
* More contributor docs improvements

* Removed table of contents from docs
2022-04-26 14:25:20 +01:00
Pokey Rule
2617c776b9
Change cursorless-dev/cursorless-vscode to cursorless-dev/cursorless (#656)
* Change `cursorless-dev/cursorless-vscode` to `cursorless-dev/cursorless`

* Switch to plain format for template link

* Fix permalink
2022-04-26 13:56:23 +01:00
AndrewDant
0fa149b960
add simple explanation of vscode actions (#631)
* add simple explanation of vscode actions

* add a short description of four vscode actions in the documentation

* fix for merge conflict with another documentation update

* Apply suggestions from code review

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
2022-04-26 11:39:59 +01:00
Pokey Rule
c5644ee753
Clarify install instructions (#651) 2022-04-25 19:06:37 +02:00
Pokey Rule
4c0676728c Run pre-commit 2022-04-25 11:21:26 +01:00
AndrewDant
95890de171
Update docs to clarify that all actions require a target (#628) 2022-04-13 12:53:44 -07:00
Will Sommers
849d591ba8
Update installation.md (#626) 2022-03-30 08:14:30 -07:00
Kirill Dubovitskiy
d90a3698f1
Serve docs folder and API reference on GitHub pages (#477)
* Inline documentation added for some key functions

* Docusaurus minimal set up added

* Fixed links to repository sub directories

* Added contributing/api using TypeDoc

* Updated publish docs workflow

* Link hack docs, publish only on main branch

* Update website/docusaurus.config.js

More robust fixing relative link to repository artifacts

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

* Addressed review comments; Github workflow to test documentation build added

* Update .github/workflows/deploy-docs.yml

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

* Update .github/workflows/deploy-docs.yml

Deployment should be authored by cursor less bot

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

* Apply pull request suggestion

* missing-exports plugging added

* Moved contributing; Added new API index page

* Avoid copying docs folder

* Fix links to GitHub after docs folder move in previous commit

* Fixed issue were relative links were rewritten to point to GitHub

* Add stub contributing

* Fix broken link to svg calculations

* Add broken markdown link checker

* Update tagline and run dock sours can fig through prettier

* Disable markdown link checking in CHANGELOG.md

* Factored out typedoc configuration from docusaurus

* Prevents broken links like https://.../../ generated

* Fixed link giving warning

* Fixed typo

* Better docusaurus config documentation

* Serve folder with /docs/ subdir <- website/build for baseUrl to work correctly

* Added CNAME to gh-pages root. Otherwise adhock commits when updated from GitHub Pages UI

* Cleanup docs

* Docs

* More docs

* Update docs-build.sh to clean out old artifacts

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

* runCommand fixed list numbering

* Hide API index from the sidebar

* Bumped docusaurus dependencies, minor nice improvements

* Moved dogs build script to scripts folder

* Edit launch configuration to debug docusaurus configuration

* Use `www` as default

* Switch to www

* Fix ci

* Trigger notification

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
2022-03-16 23:23:03 +00:00
Yevgeniy Kuksenko
04bf052fbe
Update README.md (#590)
`cursorless docs` command seems to have been replaced by `cursorless instructions`
2022-03-07 22:22:43 +00:00
Will Sommers
304c2d56cc
Add rewrap command to docs (#580) 2022-03-03 22:01:17 +00:00
Pokey Rule
c1030e6f20
Use .git prefix on install instructions (#576)
Closes #556
2022-02-22 13:11:19 +00:00
Robin Opletal
65621291ff
docs: document move (#574) 2022-02-21 21:40:22 +00:00
Ronald Walker
ab50e20e49
update docs - reflect changes to default terms (#553) 2022-02-11 07:47:26 +00:00
Robin Opletal
9201b50882
docs: replace "clear" with "change" (#551) 2022-02-10 13:08:43 +00:00
Pokey Rule
04fcbfeaa3
Add link wrap gif (#536)
* Add link wrap gif

* Add link snippet

* Change link wrap support and documentation
2022-02-07 19:52:41 +01:00
Pokey Rule
a465b78997
Update docs to reflect new default term "box" (#548) 2022-02-07 15:29:15 +01:00
Pokey Rule
4d35594981
Update documentation and links to reflect monorepo (#542)
* Update docs and links to monorepo

* Update a link

* Update link

* Fix up installation

* Fix up installation

* More doc tweaks

* More updates to new repo location

* Black

* More tweaks
2022-02-03 18:57:58 +00:00