Approach for the better Documentation #13
amitsingh19975
started this conversation in
Project ASCIIDOC
Replies: 1 comment
-
Thanks @amitsingh19975 for your suggestion. @shikharvashistha has already started his porting the https://www.boost.org/doc/libs/develop/libs/numeric/ublas/doc/index.html using ASCIIDOC in the style of https://www.boost.org/doc/libs/1_76_0/libs/endian/doc/html/endian.html. He shall continue and finalize it. Once done we can talk about refining the documentation for the upcoming GSoC phases. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
@shikharvashistha, I would like to know how are you approaching the documentation? What is your main focus, explaining functions, classes, etc., with or without examples? What are the different steps you're taking to achieve your target? Is there any reference you're using?
From @bassoy, I would like to know, should we also include a tutorial? If yes, then should it be within the documentation or outside the documentation?
@shikharvashistha, if you don't have the references, I would suggest
cppreference
andRust
documentation and tutorial. If @bassoy would like to add any, he's welcome. These are some of the best pieces of documentation I know.In the end, I would like to see better issues-- create smaller issues rather than one big blob, and update the project so that it answers all these questions, and if someone read the project, they can reason about the project.
Beta Was this translation helpful? Give feedback.
All reactions