Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldtse committed Aug 15, 2023
1 parent 17e9377 commit 1bb47ee
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ NOTE: This documentation covers macOS or Ubuntu Linux.
Content management workflow involves the following phases:

. Authoring: changing the contents of the repository.
Youll manipulate AsciiDoc files (`.adoc` file extension)
You'll manipulate AsciiDoc files (`.adoc` file extension)
and related files such as illustrations.

. Previewing your changes (optional):
Expand All @@ -37,7 +37,7 @@ Content management workflow involves the following phases:
This also will cause the new version of the site to be published.
(Publishing the new version may take a few minutes.)

[NOTE] Site organization is covered elsewhere
NOTE: Site organization is covered elsewhere

=== Setup

Expand Down Expand Up @@ -68,16 +68,17 @@ Most site source files (`.adoc` and otherwise) have _frontmatter_
at the beginning, in between the `---` delimiters—that frontmatter.

That frontmatter must specify the correct layout (see below)
and your pages title.
and your page's title.

After the frontmatter block, normal content (AsciiDoc, HTML, etc.) begins.
--

==== Site content

the term 'Documentation' is unclear. Is it a concept or a file path.
The term 'Documentation' is unclear. Is it a concept or a file path.

TODO: tbd

tbd
Documentation lives under the `/docs/` directory.
All documentation source pages therein must specify `layout: docs` in frontmatter.

Expand All @@ -86,7 +87,8 @@ For example, file `/docs/section-1/test-page.adoc` will be available under `ap21

===== Navigation sidebar

tbd
TODO: tbd

Documentation requires manual update when you add pages, retitle them
or move them around.

Expand All @@ -102,7 +104,8 @@ The sidebar is generated from this structure.

That page (currently `/docs/section-1/deliverables.adoc`)
is a special in that it contains code that initializes a _deliverable browser_.
[NOTE] The site is being restructued. The Deliverables page will be removed.

NOTE: The site is being restructured. The Deliverables page will be removed.

==== Posts

Expand All @@ -111,7 +114,8 @@ See the existing post for frontmatter example.

==== Other pages

(Section to be completed.)
TODO: Section to be completed.


== Previewing site locally

Expand Down

0 comments on commit 1bb47ee

Please sign in to comment.