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

Docs: complete annotated grammar reference/spec from grammar.ohm #1173

Open
novusnota opened this issue Mar 1, 2024 · 2 comments
Open

Docs: complete annotated grammar reference/spec from grammar.ohm #1173

novusnota opened this issue Mar 1, 2024 · 2 comments
Assignees
Labels
docs: Reference /ref section of the docs: API reference, standard libraries, specification and evolution kind: bug Something isn't working or isn't right kind: docs Documentation for docs.tact-lang.org kept in docs folder

Comments

@novusnota
Copy link
Member

novusnota commented Mar 1, 2024

Current grammar page doesn't bring much value, especially for those willing to work on Tact compiler development or related tooling.

The page should be moved to the Language → Reference section, and it should cover different parts of the official Tact grammar in Ohm with examples showcasing their usage in the language.

Now, it's possible to do it with syntax highlighting of Ohm code blocks thanks to the merged TextMate grammar for Ohm, brought from novusnota/vscode-ohm.

Reference links:

@novusnota novusnota added the kind: bug Something isn't working or isn't right label Mar 1, 2024
@novusnota novusnota self-assigned this Mar 1, 2024
@anton-trunov
Copy link
Member

Would be nice to render the grammar as BNF or EBNF. Being able to look at the language grammar is really valuable when you have to quickly learn a new language (a bunch of code snippets help a lot too, but a grammar in a standard form can save a lot of time).

As for the available grammars in different format, we should definitely document we have those in a different section about tooling. Basically, the Grammar page should only contain a standardized description of the Tact syntax and the concrete grammars like the one in the TextMate format or the Tree-Sitter grammar for Tact should be linked and described as tools.

@novusnota novusnota changed the title Complete annotated grammar reference from grammar.ohm Complete annotated grammar reference/spec from grammar.ohm Mar 1, 2024
@novusnota novusnota added the docs: Reference /ref section of the docs: API reference, standard libraries, specification and evolution label Mar 16, 2024
@anton-trunov anton-trunov transferred this issue from tact-lang/tact-docs Dec 12, 2024
@anton-trunov anton-trunov added the kind: docs Documentation for docs.tact-lang.org kept in docs folder label Dec 12, 2024
@anton-trunov
Copy link
Member

@verytactical you might want to look at it

@novusnota novusnota changed the title Complete annotated grammar reference/spec from grammar.ohm Docs: complete annotated grammar reference/spec from grammar.ohm Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs: Reference /ref section of the docs: API reference, standard libraries, specification and evolution kind: bug Something isn't working or isn't right kind: docs Documentation for docs.tact-lang.org kept in docs folder
Projects
None yet
Development

No branches or pull requests

3 participants