Skip to content

Commit a9937d8

Browse files
Add instructions on how to create a PR
1 parent ec43817 commit a9937d8

File tree

2 files changed

+46
-24
lines changed

2 files changed

+46
-24
lines changed

README.md

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,44 @@
44

55
An open effort to structure learning resources with meaningful connections.
66

7-
Visit the deployed [Clojure Civitas Website](https://clojurecivitas.github.io).
7+
⚡ No setup – Clone this repo, make a new namespace, start coding.
88

9-
## Rationale
9+
✍️ Write as you code – Capture notes, results, and ideas as you go as comments.
1010

11-
See [About Clojure Civitas](https://clojurecivitas.github.io/about).
11+
🚀 Easy to share – Create a Pull Request, once merged it appears on the [Clojure Civitas Website](https://clojurecivitas.github.io).
1212

13-
## Contributing
14-
15-
Your perspective matters.
13+
🧠 Build shared knowledge – Your work becomes part of a community resource.
1614

17-
<div style="text-align: center; font-family: 'Georgia', serif; font-size: 1.5rem; margin: 2rem 0; color: #2e7d32;">
18-
Exploramus, Communicamus, Crescimus<br>
19-
<small style="font-size: 1rem; color: #555;">We explore, we share, we grow.</small>
20-
</div>
15+
🧪 Use Clay – Your normal REPL workflow, but with tables, charts, markdown, and hiccup.
2116

22-
⚡ No setup – Open Civitas, make a new namespace, start coding.
17+
## Rationale
2318

24-
✍️ Write as you code – Capture notes, results, and ideas as you go.
19+
*Exploramus, Communicamus, Crescimus*<br>
20+
<small>We explore, we share, we grow.</small>
2521

26-
🚀 Easy to share – Create a PR, and it gets published.
22+
See [About Clojure Civitas](https://clojurecivitas.github.io/about).
2723

28-
🧠 Build shared knowledge – Your work becomes part of a growing community resource.
24+
## Contributing
2925

30-
🧪 Use Clay – Same REPL workflow, but with tables, charts, markdown, and hiccup.
26+
Your perspective matters.
27+
Pull Requests invited, that's the point!
3128

3229
### Write notebooks
3330

34-
Add a notebook in the [`/notebooks`](notebooks) folder.
31+
Add a notebook (Clojure namespace or markdown file) in the [`/notebooks`](notebooks) folder.
3532

36-
See the [Clay Documentation](https://scicloj.github.io/clay) for information on how to interactively visualize the
37-
notebook as you write it.
38-
Author profile can be configured in [clay.edn](clay.edn).
33+
Configure your author profile in [clay.edn](clay.edn).
3934

40-
### Build the database
35+
**Optional:** Use [Kindly](https://scicloj.github.io/kindly-noted/kindly) annotations in your notebook to make visualizations
4136

42-
Add to or modify [db.edn](quarto/db.edn)
37+
```clojure
38+
^kind/hiccup
39+
[:svg [:circle {:r 50}]]
40+
```
41+
42+
**Optional:** Use [Clay](https://scicloj.github.io/clay/#setup) to visualize the notebook as you write it.
4343

44-
### Preview the full website
44+
**Optional:** Preview the final website
4545

4646
```sh
4747
clojure -M:clay -a [:markdown]
@@ -51,10 +51,24 @@ clojure -M:clay -a [:markdown]
5151
quarto preview site
5252
```
5353

54+
[Quarto](https://quarto.org/) is a markdown publishing tool that enhances
55+
[Pandoc](https://pandoc.org/).
56+
5457
### Publish
5558

5659
Merged pull requests are shown on the website via a workflow.
5760

61+
To create a pull request
62+
63+
1. fork the repository
64+
2. make and commit changes in a new branch
65+
3. push the branch to your fork
66+
4. and then open a pull request on GitHub to propose merging your changes into the Civitas main branch.
67+
68+
### Building the database
69+
70+
Add to or modify [db.edn](quarto/db.edn)
71+
5872
## Design
5973

6074
Align with Clojure's values: simplicity, community, and tooling that helps you think.

site/about.qmd

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ No infrastructure required.
2626
</div>
2727
</div>
2828

29+
"Civitas" refers to a community of citizens, encompassing the rights, duties, and privileges associated with belonging.
30+
It's a term that signifies citizenship, not just a physical city, but also the political and social fabric of the community.
31+
32+
## Usage
33+
34+
See [README.md](https://github.com/ClojureCivitas/clojurecivitas.github.io/blob/main/README.md).
35+
2936
## Rationale
3037

3138
Clojure and markdown are a natural fit for interactive, literate programming.
@@ -35,9 +42,9 @@ This friction discourages experimentation and makes publishing harder than it ne
3542

3643
### Make Publishing Notebooks Easy
3744

38-
[Clay](https://scicloj.github.io/clay/) notebooks combine Clojure and markdown for expressive, interactive literate programming.
45+
Notebooks combine Clojure and markdown for expressive, interactive literate programming.
3946
Compared to blogs, gists, or repos, they better support combining narrative, code, and results in a single document.
40-
Civitas removes the friction of publishing by letting anyone submit notebooks or markdown without setting up a new project or hosting workflow.
47+
Civitas removes the friction of publishing by enabling you to submit notebooks or markdown without setting up a new project or hosting workflow.
4148
It provides a shared, well-organized platform for short experiments, tutorials, notes, and blog posts.
4249

4350
### Build a Database of Knowledge
@@ -78,4 +85,5 @@ See the [Clojure Civitas Analytics Dashboard](https://clojurecivitas.goatcounter
7885

7986
### Technical Details
8087

88+
Made with [Clay](https://scicloj.github.io/clay/).
8189
See the [README.md](https://github.com/ClojureCivitas/clojurecivitas.github.io/blob/main/README.md) in the repository for contribution guidelines and technical details.

0 commit comments

Comments
 (0)