-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a roadmap and contribution sections.
- Loading branch information
1 parent
852350e
commit f5140be
Showing
4 changed files
with
78 additions
and
5 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,36 @@ | ||
(uiop:define-package #:staticl-docs/contribution | ||
(:use #:cl) | ||
(:import-from #:named-readtables | ||
#:in-readtable) | ||
(:import-from #:40ants-doc | ||
#:defsection) | ||
(:import-from #:pythonic-string-reader | ||
#:pythonic-string-syntax)) | ||
(in-package #:staticl-docs/contribution) | ||
|
||
|
||
(in-readtable pythonic-string-syntax) | ||
|
||
(defsection @contribution (:title "Contribution") | ||
""" | ||
I'll be happy to discuss your ideas in the issues and to review your pull-requests. | ||
Follow these few rules to make it be merged faster: | ||
* Write a detailed description of the changes made in the pull request. | ||
* Keep the same style as in the rest of code. | ||
* If unsure, check [Google's Common Lisp Styleguide](https://google.github.io/styleguide/lispguide.xml). | ||
* Write a test on added functionality. | ||
* Describe your changes in the `docs/changelog.lisp` file. This way documentation and a ChangeLog.md file will be updated after the merge. | ||
* Make changes to the documentation files inside the `docs/` folder. | ||
* Ensure all checks on the pull request are green. | ||
""" | ||
(@contributors section)) | ||
|
||
|
||
(defsection @contributors (:title "Contributors") | ||
""" | ||
* Alexander Artemenko (initial author). | ||
""" | ||
) |
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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
(uiop:define-package #:staticl-docs/roadmap | ||
(:use #:cl) | ||
(:import-from #:named-readtables | ||
#:in-readtable) | ||
(:import-from #:40ants-doc | ||
#:defsection) | ||
(:import-from #:pythonic-string-reader | ||
#:pythonic-string-syntax)) | ||
(in-package #:staticl-docs/roadmap) | ||
|
||
|
||
(in-readtable pythonic-string-syntax) | ||
|
||
(defsection @roadmap (:title "Roadmap") | ||
""" | ||
* Add support for translations for themes and menu items to be able to make multilingual sites. | ||
* Add a documentation on theme and plugin creation. | ||
* Implement more themes. | ||
* Port all [Coleslaw plugins](https://github.com/coleslaw-org/coleslaw/tree/master/plugins). | ||
* Support more services for adding comments. | ||
* Make cool demos for YouTube and publish them at [40Ants channel](https://www.youtube.com/channel/UCeQ6iZT5nmAGFHX1b4V6dQw). | ||
""" | ||
) |