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

Provide How Tos for the Cursor API #334

Closed
OmarTawfik opened this issue Feb 22, 2023 · 0 comments · Fixed by #540, #716 or #729
Closed

Provide How Tos for the Cursor API #334

OmarTawfik opened this issue Feb 22, 2023 · 0 comments · Fixed by #540, #716 or #729
Assignees
@Xanewok

Comments

@OmarTawfik
Copy link
Collaborator

OmarTawfik commented Feb 22, 2023 •
edited by Xanewok
Loading

https://documentation.divio.com/how-to-guides.html
@OmarTawfik OmarTawfik added this to the 2️⃣ Beta Preview milestone Feb 22, 2023
@OmarTawfik OmarTawfik moved this to ⏲ Todo in Slang - 2023 H1 Feb 22, 2023
@OmarTawfik OmarTawfik mentioned this issue Feb 22, 2023
Merged
@OmarTawfik OmarTawfik removed this from the 2️⃣ Beta Preview milestone Jul 11, 2023
@OmarTawfik OmarTawfik changed the title ship CST Visitor API in TypeScript, not just Rust ship Visitor+Cursor APIs in TypeScript+Rust Jul 19, 2023
@OmarTawfik OmarTawfik changed the title ship Visitor+Cursor APIs in TypeScript+Rust ship Visitor and Cursor APIs with How Tos Jul 19, 2023
@OmarTawfik OmarTawfik changed the title ship Visitor and Cursor APIs with How Tos ship Visitor and Cursor APIs, including How Tos Jul 19, 2023
@OmarTawfik OmarTawfik linked a pull request Jul 20, 2023 that will close this issue
Rust & Typescript Cursors for the CST #540
Merged
@Xanewok Xanewok removed this from Slang - 2023 Q3 Nov 2, 2023
@Xanewok Xanewok assigned Xanewok and unassigned AntonyBlakey Nov 3, 2023
@Xanewok Xanewok mentioned this issue Nov 24, 2023
Merged
@Xanewok Xanewok mentioned this issue Dec 2, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Dec 3, 2023
@Xanewok
doc: Add an introduction and a design overview to the user guide (#674)
0d38622 
In preparation for #334 (and other how-tos).

This adds a bit more introduction and context to the user guide that
should be independent on the actual API used (Rust/TS) and also provides
stubs for the How-Tos on the parsing/navigating the syntax tree.

When I tried to write these specific how-tos, I thought that we should
be able to define, at least from the higher level, what the CST is, how
the process looks like and add some more context (e.g. multiple versions
and why we need to create a specific version for the language, first).
Also this helps establish a bit more structure to the guide that should
help with writing more documentation/guides as we go.

Ironically, http://shader-slang.com/slang/user-guide/index.html helped
me structure this a bit as a guide that the user is welcomed to and what
they might benefit from (intro, context) before diving deeper into the
guides/context.
@Xanewok Xanewok changed the title ship Visitor and Cursor APIs, including How Tos ship Cursor APIs, including How Tos Dec 14, 2023
@Xanewok Xanewok changed the title ship Cursor APIs, including How Tos Provide How Tos for the Cursor API Dec 14, 2023
@Xanewok Xanewok mentioned this issue Dec 18, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Dec 19, 2023
@Xanewok
Add How-to guides on parsing Solidity for CLI/Rust/NPM (#716)
874ca24 
Closes #334 

This adds a more hands-on intro to the parsing API and adds two examples
on how to use it:
- how to reconstruct the source: it's a kind of a "hello world" since
you only visit and print the contents and it helps reinforce that the
CST is, in fact, complete (wrt trivia)
- how to list contracts and their names - it's simple, real worldsy and
uses two different node kinds in a simple relationship.

This is done for Rust CLI, Rust library and the NPM package used as a
library.

With this, we could probably get rid of the content from the respective
index pages for Rust/NPM package and use this as the introductory first
subpage as it overlaps with it now a bit.

Let me know if this is the direction we want to go in; didn't want to
add more involved examples until I was sure that's what we want.
@OmarTawfik OmarTawfik reopened this Dec 21, 2023
@Xanewok Xanewok mentioned this issue Jan 4, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Jan 9, 2024
@Xanewok
Add a "How to use the CST cursor" How-To (#729)
0727cf8 
Closes #334
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Xanewok Xanewok

Labels
None yet
Projects
No open projects
Slang - 2023 Q4
Status: No status
Milestone
No milestone
3 participants
@AntonyBlakey @Xanewok @OmarTawfik