cursorless-dev/cursorless
1
1
Fork 0
mirror of https://github.com/cursorless-dev/cursorless.git synced 2024-10-04 21:07:21 +03:00
Code Issues Packages Projects Releases Wiki Activity
255e889547
cursorless/docs/contributing/_api-index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

11 lines
506 B
Markdown
Raw Normal View History

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-17 02:23:03 +03:00
# Cursorless internals
Minor Cursorless docs follow-up tweaks (#610) * Have a bit more exposition and point to API doc landing page on contributing landing page. Fixes #609 * Test broken link * Fail on docs build fail * Remove broken link * Various stuff * Remove unnecessary markdown link checker * Fix link * More docs cleanup * Tweak deploy setup
2022-03-18 13:58:00 +03:00
This document is intended to present a high-level overview of the Cursorless
architecture, as well as key pointers to locations in the code base to help
contributors get up to speed.
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-17 02:23:03 +03:00
Minor Cursorless docs follow-up tweaks (#610) * Have a bit more exposition and point to API doc landing page on contributing landing page. Fixes #609 * Test broken link * Fail on docs build fail * Remove broken link * Various stuff * Remove unnecessary markdown link checker * Fix link * More docs cleanup * Tweak deploy setup
2022-03-18 13:58:00 +03:00
For the time being, we recommend watching the [internals walk-through
videos](https://youtube.com/playlist?list=PLkafpFOBVedScHi0dy_80DsHwnZIOSOTy)
and having a look through the API docs, starting from the [`runCommand`
function](classes/core_commandRunner_CommandRunner.CommandRunner#runcommand).
Reference in New Issue Copy Permalink