Skip to content

Commit

Permalink
Add links to the "Introduction to Clang for Clad contributors" doc
Browse files Browse the repository at this point in the history
This commit updates the contributing guidelines and the developers
documentation to have link to the newly created doc for beginner
contributors.
  • Loading branch information
gojakuch committed Jun 14, 2024
1 parent 4ebd1af commit bf48b28
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,9 @@ review quickly and successfully share several common traits:
### Developer Documentation

We have documented several useful hints that usually help when addressing issues
as they come during developement time in our [developer documentation](https://clad.readthedocs.io/en/latest/user/DevelopersDocumentation.html).
as they come during developement time in our [developer documentation](https://clad.readthedocs.io/en/latest/user/DevelopersDocumentation.html).

In case you are interested in seeing the big picture and are just getting
started with Clang, there is a document that might interest you: [Introduction to Clang for Clad contributors](https://docs.google.com/document/d/1Dw4BLlWODmR3ohiu_ezswzuJNFQwAA8FRU3WNnvdBrQ/edit?usp=sharing).
It covers most of the basic concepts in Clang that Clad uses and describes the operation
of the latter with examples for newcomers specifically.
5 changes: 5 additions & 0 deletions docs/userDocs/source/user/DevelopersDocumentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,11 @@ to understand for the new developers.
Internal documentation can be visited
`here </en/latest/internalDocs/html/index.html>`_

In case you are interested in seeing the big picture and are just getting
started with Clang, there is a document that might interest you:
`Introduction to Clang for Clad contributors <https://docs.google.com/document/d/1Dw4BLlWODmR3ohiu_ezswzuJNFQwAA8FRU3WNnvdBrQ/edit?usp=sharing>`__. It covers
most of the basic concepts in Clang that Clad uses and describes the operation
of the latter with examples for newcomers specifically.
Clad's Tests
============

Expand Down

0 comments on commit bf48b28

Please sign in to comment.