Skip to content

Commit

Permalink
0.0.4 docs/index.md Update provisional information + image
Browse files Browse the repository at this point in the history
  • Loading branch information
orcmid committed Aug 17, 2023
1 parent cd16f76 commit 3f7db62
Showing 1 changed file with 43 additions and 8 deletions.
51 changes: 43 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- index.md 0.0.3 UTF-8 dh:2022-03-21
<!-- index.md 0.0.4 UTF-8 dh:2023-08-17
----1----|----2----|----3----|----4----|----5----|----6----|----7----|--
source <https://github.com/orcmid/docEng/blob/main/docs/index.md>
construction structure, manifest, and job jar at
Expand All @@ -7,21 +7,34 @@

# The docEng Project on GitHub

![Document Engineering](images/DocEng-2022-10-14-0744-LogoLarge.png)

This space is under construction. This page will become the home page for
The docEng Project documentation on GitHub. One aspect of the Document
Engineering is that the site is always published and must be ready for
publication on any check-in pushed to the project repository. Words in the
open is practiced here, along with having any code in the open.

The effort is a form of solo document engineering at this point.
The effort is a form of solo document engineering at this point. It is a bit
of Document Engineering about Document Engineering.

One interest is focus on the ways that GitHub can be used for document
authoring and (web) publication in useful ways, even though writing Markdown
pages and collaboration via GitHub may be rather alien to folks who just want
to author technical documents. We need to look at the friction of that and
alternatives that may be improvements.

## Axe Sharpening

This is an experimental employment of GitHub Pages at `master/docs/` to see
whether the documentation and blogging needs of the project can be met here
This is an experimental employment of GitHub Pages to see
whether the documentation and blogging needs of projects can be met here
with minimal fuss. That activity is documented here.

The published form of the pages is at <https://orcmid.github.io/docEng/>
An additional activity of some importance to this author is using GitHub
as a means of preservation and continuation of some web sites that were under
different publishing models.

The published form of this material is at <https://orcmid.github.io/docEng/>

Notes on the plumbing within the structure are found at pages such as
[docs.txt](docs.txt). Such text pages are moved intact to the published
Expand All @@ -36,16 +49,38 @@ reflow on change of browser view width is automatic and as desired.
I do have some concerns about explicit versioning and having content that
is skipped. I can specify HTML comments for that, and I am doing so.

We will run through all of the Markdown options to see how they are
We will also run through all of the Markdown options to see how they are
rendered here. Theme demos provide a nice comparison.

Demonstration of the current theme, including the markdown elements, is
at [current](construction/current/) here.

Placeholder initiated 2021-02-15T23:56Z
Construction structure at <https://orcmid.github.io/docEng/docs.txt>
## docEng Table of Content

The nfoTools web is organized in topical sections.

| **Section** | **General Topic** |
| --: | --- |
| others | watch this space |
| [preservation](preservation/) | Approaches to preservation/forking of web documentation sites |
| | |
| [construction](construction/) | docEng Web Construction Materials |

There will be links to related material and resources.

----

I invite discussion about docEng topics in the
[Discussion section](https://github.com/orcmid/docEng/discussions).
Improvements and removal of defects in this particular documentation can be
reported and addressed in the
[Issues section](https://github.com/orcmid/docEng/issues). There are also
relevant [projects](https://github.com/orcmid/docEng/projects?type=classic)
from time to time.


<!--
0.0.4 2023-08-17T03:17Z Start expanding, and the big logo image
0.0.3 2022-03-21T17:38Z Correct Construction structure link
0.0.2 2021-10-29T21:54Z Smoothing, changing "master" to "main"
0.0.1 2021-02-15T23:54Z Adapt the Miser Project docs/index.md 0.0.4
Expand Down

0 comments on commit 3f7db62

Please sign in to comment.