-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from premAI-io/framework-v1
- Loading branch information
Showing
7 changed files
with
55 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Review checklist | ||
|
||
> Don't worry about satisfying all items, it's fine to open a (draft) PR. | ||
- [ ] chapter content | ||
+ [ ] only one top-level `# h1-Title` | ||
+ [ ] summary (e.g. table or TL;DR overview), no need for an explicit `## Summary/Introduction` title or equivalent | ||
+ [ ] main content focus: recent developments in open source AI | ||
+ general context/background (brief) | ||
+ current pros/cons | ||
+ in-depth insights (not yet widely known) | ||
+ [ ] likely `## Future` developments | ||
+ [ ] end with `{{ comments }}` | ||
- [ ] appropriate citations | ||
+ [ ] BibTeX references | ||
+ [ ] Glossary terms | ||
+ [ ] cross-references (figures/chapters) | ||
+ [ ] (if `new-chapter.md`), add `_toc.yml` entry & `index.md` table row | ||
+ [ ] If CI URL checks have false-positives, append to `_config.yml:sphinx.config.linkcheck*` | ||
- [ ] images & data not committed to this repo (e.g. use https://github.com/premAI-io/static.premai.io instead) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
jupyter-book | ||
sphinxemoji | ||
# TODO: remove after https://github.com/executablebooks/jupyter-book/pull/2048 | ||
docutils!=0.18.*,!=0.19.*,!=0.20.0 |