Skip to content

Commit c79448a

Browse files
authored
Merge pull request #364 from ohmg-dev/docs_update
small docs updates
2 parents 907b514 + 52ec363 commit c79448a

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

docs/developers/docs-install.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ This documentation is built with [Zensical](https://zensical.org), and is very e
3333
3434
You can now view the docs in a browser at `http://localhost:8000`.
3535
36-
## Editing content
36+
## Writing content
3737
38-
All documention is written in Markdown (.md) files inside of the `/docs` directory. CSS modifications are in `docs/stylesheets/extra.css`.
38+
All documention is written in Markdown (.md) files inside of the `/docs` directory. Here's an introduction to [basic syntax for Markdown](https://www.markdownguide.org/basic-syntax/).
39+
40+
Place any images/screenshots into `/docs/images/` and reference them with relative paths (find an exising example of an image in the docs to follow).
41+
42+
The table of contents is defined in the top-level `zensical.toml` file.
43+
44+
CSS modifications are in `docs/stylesheets/extra.css`.

docs/walkthroughs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Walkthroughs
2+
3+
Walkthroughs provide a comprehensive and zoomed-out explanation of how multi-step workflows are carried out within the platform, especially those that span multiple tool interfaces and can be performed by many different users at different times.
4+
5+
- [Working through a full multi-page Sanborn map | New Iberia, La., 1885](new-iberia-la-1885.md)

0 commit comments

Comments
 (0)