update contributing docs
This commit is contained in:
Tolaria
parent
4421378529
commit
1b1e4dc154
2 changed files with 18 additions and 14 deletions
|
|
@ -5,9 +5,9 @@ icon: lucide/heart-handshake
|
|||
|
||||
# Contributing to Tree of Ascension Docs
|
||||
|
||||
Welcome! This guide will get you from zero to making your first edit — even if you've never used git before.
|
||||
Welcome! This guide will get you from zero to making your first edit or new post contribution to Tree of Ascension Docs.
|
||||
|
||||
> **🔒 Registration is currently closed.** New contributor accounts are not available at this moment. If you'd like to get involved, solve the puzzle below to reveal the contact email and request access.
|
||||
> **🔒 Registration is currently closed.** Self-registration of new contributor accounts are not available at this moment. If you'd like to get involved, solve the puzzle below to reveal the contact email and request access.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -70,12 +70,12 @@ Once you have access, read on below.
|
|||
|
||||
## 🛠 How it works
|
||||
|
||||
| What | Details |
|
||||
| ---------------- | -------------------------------------------------------------------------------------------- |
|
||||
| **Site host** | [Forgejo](https://forgejo.org) — a friendly, self-hosted git platform |
|
||||
| **Repo** | [bali.krystl.org/aja/up](https://bali.krystl.org/aja/up) |
|
||||
| **Built with** | [Zensical](https://zensical.org) — turns Markdown files into a beautiful docs site |
|
||||
| **Local editor** | [Tolaria](https://tolaria.dev) — a simple desktop app for editing Markdown with git built in |
|
||||
| What | Details |
|
||||
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| **Code and file hosting** | [Forgejo](https://forgejo.org) — a friendly, self-hosted git (version control) platform that manages changes and files between many users. Git is a distributed open source tool that lets you work on a folder of files and handles the cases where two users have edited the same file (called merge conflicts). |
|
||||
| **Repo** | [bali.krystl.org/aja/up](https://bali.krystl.org/aja/up) |
|
||||
| **Built with** | [Zensical](https://zensical.org) — turns Markdown files into a beautiful docs site |
|
||||
| **Local editor** | [Tolaria](https://tolaria.dev) — a simple desktop app for editing Markdown with git built in |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -89,7 +89,7 @@ Go to **[bali.krystl.org/aja/up](https://bali.krystl.org/aja/up)** and sign in w
|
|||
|
||||
### Step 2 — Create your branch
|
||||
|
||||
Every edit lives on its own branch. This keeps the main site safe while you work.
|
||||
Every edit lives on its own branch. A branch is a copy of the code that can be kept independent and later merged. This keeps the main site safe while you work and allows us to review and approve or comment on changes.
|
||||
|
||||
- Click the **branch dropdown** (near the top of the page, it probably says `main` or `master`)
|
||||
- Type a short name for your branch — like `add-meditation-guide` or `fix-typo-daily-sadhana`
|
||||
|
|
@ -125,12 +125,13 @@ If you prefer to work on your own computer:
|
|||
|
||||
### You'll need
|
||||
|
||||
- **[git](https://git-scm.com/downloads)** — the version control tool
|
||||
- **[Tolaria](https://tolaria.dev)** — a friendly Markdown editor with git support
|
||||
- You can also use any text editor together with **[git](https://git-scm.com/downloads)** — the version control tool
|
||||
|
||||
### Steps
|
||||
|
||||
```bash
|
||||
|
||||
# 1. Clone the repo
|
||||
git clone https://bali.krystl.org/aja/up.git
|
||||
cd up
|
||||
|
|
@ -144,6 +145,9 @@ git checkout -b my-edit
|
|||
git add .
|
||||
git commit -m "Describe your changes"
|
||||
git push -u origin my-edit
|
||||
|
||||
# At this point you'll be asked for your username and password.
|
||||
# You can also set up an SSH key which will mean you don't need to type these every time (you will need to email us your public key)
|
||||
```
|
||||
|
||||
Then follow Step 4 above ("Open a Pull Request") to open your pull request on Forgejo.
|
||||
|
|
@ -213,4 +217,3 @@ That's it — you now have your own Zensical-powered knowledge garden.
|
|||
---
|
||||
|
||||
Questions? Found a bug? **[Open an issue](https://bali.krystl.org/aja/up/issues)** on the repo.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
icon: simple/markdown
|
||||
---
|
||||
|
||||
# Markdown in 5min
|
||||
|
||||
## Introduction to Markdown Language
|
||||
|
||||
Markdown is a simple language to build web pages. It is easier to read and write than HTML (the language web browsers read) and so we use it to write articles. You can use this reference to help you write posts and pages directly in our repository where the source documents for this wiki are held. See [[docs/contributing/index]] for more.
|
||||
Markdown is a simple language to build web pages. It is easier to read and write than HTML (the language web browsers read) and so we use it to write articles and have a system called Zensical that will compile your Markdown into HTML. You can use this reference to help you write posts and pages directly in our repository where the source documents for this wiki are held. See [[docs/contributing/index]] for more and check the Zensical docs on authoring for a more complete set of markdown notations you can use with Tree.
|
||||
|
||||
## Headers
|
||||
|
||||
|
|
@ -68,7 +69,7 @@ Ordered:
|
|||
function hello() {
|
||||
console.log("Hello, world!");
|
||||
}
|
||||
```
|
||||
```;
|
||||
````
|
||||
|
||||
## Tables
|
||||
|
|
@ -107,7 +108,7 @@ Use backslash to escape: \* \_ \# \`
|
|||
## Line breaks
|
||||
|
||||
```text
|
||||
End a line with two spaces
|
||||
End a line with two spaces
|
||||
to create a line break.
|
||||
|
||||
Or use a blank line for a new paragraph.
|
||||
|
|
|
|||
Loading…
Reference in a new issue