Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restructure documentation to reflect new compositional modifiers #867

Open
7 tasks
pokey opened this issue Jul 14, 2022 · 0 comments
Open
7 tasks

Restructure documentation to reflect new compositional modifiers #867

pokey opened this issue Jul 14, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
Short list

Comments

@pokey
Copy link
Member

pokey commented Jul 14, 2022 •
edited
Loading

We'd like to restructure out documentation to more accurately reflect Cursorless's new internal representation. We should have sections for:

  • Scope types
  • Modifiers
  • Actions

They can link to each other. So for example the "containing scope" modifier can link to list of scope types

  • Also discuss frontmatter thing for auto-generating docs

Scope types should include:

  • Languages supported
  • Examples from different languages
  • Iteration scope
  • Domain
  • Removal range
  • Content range

Could include info from test cases as per #866?

See also some (very rough 😅) images from a brainstorming session:

IMG_8536
IMG_8535
IMG_8534
IMG_8539
IMG_8538
IMG_8537
@pokey pokey added the documentation Improvements or additions to documentation label Jul 14, 2022
@pokey pokey changed the title Restructure documentation Restructure documentation to reflect new compositional modifiers Jul 14, 2022
@pokey pokey added this to the 0.27.0 milestone Aug 18, 2022
@pokey pokey mentioned this issue Oct 3, 2022
Merged
5 tasks
@pokey pokey added the to discuss Plan to discuss at meet-up label Jul 6, 2023
@pokey pokey mentioned this issue Jul 16, 2023
Open
@AndreasArvidsson AndreasArvidsson removed their assignment Jul 22, 2023
@pokey pokey mentioned this issue Aug 8, 2023
Merged
3 tasks
github-merge-queue bot pushed a commit that referenced this issue Aug 9, 2023
@pokey
Bump docusaurus to 3.0.0-alpha.0 (#1745)
16973f8 
We have some security warnings on a couple packages that are
dependencies of docusaurus, so I decided to upgrade to the latest to
remove those dependencies. Docusaurus uses their nightly version on
their own docs, and things seem to work for us on this version with no
issue, so I think it's ok. In addition, we were violating their peer
dependencies by using react 18; we now no longer need to do that. Also,
this version allows us to use mdx v2, which has a lot of niceties that
we'll probably want as we do our big docs refactor
(#867)

- depends on #1750 to
fix typedoc failure

## Checklist

- [ ] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [ ] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [ ] I have not broken the cheatsheet
@pokey pokey removed the to discuss Plan to discuss at meet-up label Mar 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Short list
Development

No branches or pull requests
2 participants
@pokey @AndreasArvidsson