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

Added new mkdocs based documentation to the project #261

Merged
merged 26 commits into from
Nov 19, 2024
Merged

Conversation

alxn4
Copy link
Member

@alxn4 alxn4 commented Nov 15, 2024

No description provided.

@liuzicheng1987
Copy link
Contributor

@alxn4 , looks great, but there are a few minor things to be fixed:

  • The link to the benchmarks in the Design Principles section (both README and Documentation) leads to a 404.
  • The headers in the README are messed up: "Feature Overview" should be an L2 header and all headers below that L3, but it is an L1 header.
  • The three links in the second paragraph of the Installation section of the documentation don't seem to be doing anything.
  • "reflect-cpp in a nutshell" seems to be a pointless header, because it consists of only one subheader "Why do we need this?" (which more accurately summarizes the text)
  • In the last paragraph in section on structs of the documentation, there are two links to custom classes and custom parsers - they both point back to the Github repo.

@liuzicheng1987 liuzicheng1987 merged commit 7a7b58f into main Nov 19, 2024
11 checks passed
@liuzicheng1987 liuzicheng1987 deleted the f/mkdocs branch November 19, 2024 21:29
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.

3 participants