VbzCart/meta

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
Jump to navigation Jump to search

Organization

There are two main types of documentation: technical and user. They can cross-link to each other where appropriate.

  • Technical documentation consists of:
    • pieces: concepts and how-to
    • coding: actual code (data structures and source code repos)
  • User documentation is designed to be invoked from within the software's web interface, and hence is rooted at ui:
  • ui: root page
    • ui/terms: terminology
    • ui/pages: help for specific pages/areas within the software

I'm considering renaming "ui" to "help" and "pages" to "ui". We would then have:

Tools

Templates for linking to documentation pages:
https://htyp.org/VbzCart/meta
htyp.org
crawl=CC-MAIN-2022-21
22106
application/http; msgtype=response
sha1:CYSD5QZBQAO6UFRQ7TV7WWD4MGM7KBWI
<urn:uuid:467cbed0-be3d-4a23-9017-e24ee4e9b1ee>
2022-05-20T14:44:20Z
165.227.176.23
text/html
sha1:2YQUGFBJKXFMPSBOGQOZ2CI6L2GWH7OI
<urn:uuid:7edf7a0c-87fa-49f4-9e63-26dffd94e1c4>
https://htyp.org/VbzCart/meta
response
<urn:uuid:019b0519-6c3e-4033-8432-af30f3715e55>
isPartOf: CC-MAIN-2022-21
publisher: Common Crawl
description: Wide crawl of the web for May 2022
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-222
software: Apache Nutch 1.18 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.3-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/