This PR introduces a new section called "Design choices" to the docs.
There are several choices that we made while designing the QREF format that might be surprising to the users. The newly added "Design choices" section discusses the choices we think are controversial and explains why they were made.
To test simply install QREF with docs dependencies:
poetry install --with docs
And then run mkdocs serve.
Please verify that you have completed the following steps
[x] I have self-reviewed my code.
[ ] I have included test cases validating introduced feature/fix.
Description
This PR introduces a new section called "Design choices" to the docs.
There are several choices that we made while designing the QREF format that might be surprising to the users. The newly added "Design choices" section discusses the choices we think are controversial and explains why they were made.
To test simply install QREF with docs dependencies:
And then run
mkdocs serve.Please verify that you have completed the following steps