Skip to content

Improve README documenting the syntax#409

Merged
mishig25 merged 7 commits into
mainfrom
better_readme
Sep 26, 2023
Merged

Improve README documenting the syntax#409
mishig25 merged 7 commits into
mainfrom
better_readme

Conversation

@mishig25

@mishig25 mishig25 commented Sep 26, 2023

Copy link
Copy Markdown
Contributor

TLDR: improve the README

  • add an actual example to every syntax keyword
  • add non-documented syntax (Yields, frameworkcontent, latex)
  • organize readme with toctree and correct level of headings
  • add table of contents for faster navigation

@mishig25 mishig25 merged commit 2fc8d7a into main Sep 26, 2023
@mishig25 mishig25 deleted the better_readme branch September 26, 2023 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant