Documentation

[rossberg]

Opening this to track documentation TODOs:

• Overview
• Language
• Usage
• Latex backend
• Prose backend
• Interpreter backend
• Splicing

[f52985]

Hey Andreas,

I've written some simple documents for the prose and the interpreter backends.
Currently, It's more focused on the role as the guide for the SpecTec users (not the SpecTec implementors), so some of the details (i.e. the detailed behavior of each prose steps) are left as TODOs for now.

[rossberg]

@f52985, thanks for this! This looks good to me.

Do you think we could also add sections listing the hardcoded assumptions that the prose & interpreter backends make about the input specification? They constrain what a user can write or change, so would be important to know.

Regarding the interpreter, isn't another dependency on the reference interpreter the implementation of (some) numerics?

[f52985]

Do you think we could also add sections listing the hardcoded assumptions that the prose & interpreter backends make about the input specification? They constrain what a user can write or change, so would be important to know.

Sounds like a good idea! I'll come up with the list of hardcoded assumptions.

Regarding the interpreter, isn't another dependency on the reference interpreter the implementation of (some) numerics?

Oops, I missed them. Yes, you are right! I'll also add them.

[rossberg]

Sounds like a good idea! I'll come up with the list of hardcoded assumptions.

@f52985, did you get a chance to do this?

[sukyoung]

Yes, we're compiling a list of hardcoded assumptions. I think it'll be ready in a few weeks.

[sukyoung]

The list is now available at: Assumptions.md.