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.

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

[FEATURE] CN language reference #117

Open
3 tasks
thatplguy opened this issue Aug 14, 2024 · 2 comments
Open
3 tasks

[FEATURE] CN language reference #117

thatplguy opened this issue Aug 14, 2024 · 2 comments
Assignees
Labels
CN Issues related to the CN tool documentation Improvements or additions to documentation Galois Galois, Inc.

Comments

@thatplguy
Copy link
Collaborator

Summary

Create a reference document that lists the syntax and (informal) semantics of CN specifications.

Feature

Create a language reference that shows how to use each bit of syntax in the CN language, broken into logical groupings for quick reference.

See

Acceptance Criteria

Language reference written (or revised), publicly available, and with CI integration to ensure the code samples continue to parse with the latest version of CN.

Do

  • language reference written
  • language reference published
  • CI integration
@thatplguy thatplguy added CN Issues related to the CN tool documentation Improvements or additions to documentation Galois Galois, Inc. labels Aug 14, 2024
@thatplguy thatplguy self-assigned this Aug 14, 2024
@bcpierce00
Copy link
Collaborator

I wonder if we might want to include pointers into the sections of the tutorial where things are explained in more detail, in addition to quick examples in-line...

@kiniry
Copy link
Member

kiniry commented Aug 14, 2024

I personally find that having an EBNF specification of the/any specification language very useful wrt reminding myself of its (loose) concrete syntax, and is also very useful when writing preludes for LLMs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CN Issues related to the CN tool documentation Improvements or additions to documentation Galois Galois, Inc.
Projects
None yet
Development

No branches or pull requests

3 participants