8000 Add section on course documentation to readme. · tecladocode/python-refresher@0dabdcf · GitHub
[go: up one dir, main page]

Skip to content

Commit 0dabdcf

Browse files
committed
Add section on course documentation to readme.
1 parent 5bb3f95 commit 0dabdcf

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,10 @@ The first time you commit it may take a little longer than you'd hope, but subse
2727

2828
The Pipfile has `allow_prereleases = "true"` because for Black this is required. Make sure when installing libraries that the latest stable version is used, but try to avoid using alpha and beta versions where possible.
2929

30-
There are times where it will be unavoidable to use prerelease versions of libraries used in a course to teach actual content. We should discuss them on an individual basis. The reason for this is that if we cover an alpha version of a library, it's likely it will change by the time the course is released.
30+
There are times where it will be unavoidable to use prerelease versions of libraries used in a course to teach actual content. We should discuss them on an individual basis. The reason for this is that if we cover an alpha version of a library, it's likely it will change by the time the course is released.
31+
32+
## Creating course documentation
33+
34+
Internal course documentation (for recording purposes) should go in Notion ((https://www.notion.so/teclado/Course-Wikis-fdd4b72cb5f74e1a9d7172f03e5c24cd)[https://www.notion.so/teclado/Course-Wikis-fdd4b72cb5f74e1a9d7172f03e5c24cd]).
35+
36+
If there is documentation or files that students would benefit from having, they should be included in this repository alongside the code.

0 commit comments

Comments
 (0)
0