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: Fold the syntax guide into the reference manual #1545

Open
RyanGlScott opened this issue Jul 6, 2023 · 0 comments
Open

docs: Fold the syntax guide into the reference manual #1545

RyanGlScott opened this issue Jul 6, 2023 · 0 comments
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation

Comments

@RyanGlScott
Copy link
Contributor

Currently, the documentation for how to use Cryptol is spread across the reference manual and the syntax guide. We don't really want to have both, since the reference manual is intended to contain all of the same information as the syntax guide (indeed, the reference guide was originally based on the syntax guide as a starting point, but has grown over time).

We should remove the syntax guide, making sure that any relevant information has a corresponding home in the reference manual.

@RyanGlScott RyanGlScott added the docs LaTeX, markdown, literate haskell, or in-REPL documentation label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation
Projects
None yet
Development

No branches or pull requests

1 participant