Skip to content

Commit

Permalink
DOP-5205: Improve onboarding docs
Browse files Browse the repository at this point in the history
  • Loading branch information
i80and committed Nov 19, 2024
1 parent e0e8c3b commit 6531ca9
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 1 deletion.
30 changes: 29 additions & 1 deletion HACKING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Snooty Parser

![Data flowchart](./docs/flowchart.svg)

## Organization

The snooty parser has the following key parts:
Expand Down Expand Up @@ -145,7 +147,7 @@ To release snooty, do the following:

1. Make sure you are on the `main` branch.

2. Ensure that the "Unreleased" section of CHANGELOG.md is up-to-date and
2. Ensure that the "Unreleased" section of CHANGELOG.md is up-to-date and
commit any changes you've made.
3. Run `make cut-release BUMP_TO_VERSION=<new_version>`.
Expand Down Expand Up @@ -184,3 +186,29 @@ tag if it was created.
* Flutter is currently a fork to add support for line numbers. We need to
figure out a cleaner way of doing this so we can merge it into the
upstream codebase.
## Glossary
<dl>
<dt>reStructuredText</dt>
<dd>A markup language identified with the Python ecosystem.</dd>
<dt>Abstract Syntax Tree (AST)</dt>
<dd>A tree of nodes which reflect the syntactic structure of an unparsed textual document.</dd>
<dt>Postprocessor</dt>
<dd>The component of snooty which performs global link analysis and other forms of processing that spans multiple files.</dd>
<dt>docutils</dt>
<dd>The canonical parsing library for reStructuredText.</dd>
<dt>tinydocutils</dt>
<dd>Our vendored fork of docutils, modified to be statically typed and less reliant on method dispatch through string manipulation.</dd>
<dt>Giza</dt>
<dd>The primary entry point of the docs' original tech stack: it would download assets, generate reStructuredText from YAML files (hence the `gizaparser/` directory for compatibility), and invoke Sphinx.</dd>

<dt>Sphinx</dt>
<dd>The primary unofficially official documentation toolchain for reStructuredText.</dd>
</dl>
9 changes: 9 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
The Snooty Parser
=================

The Snooty Parser is a tool that takes a reStructuredText documentation corpus and
generates a node tree suitable for straightforward conversion into HTML.

Development
-----------

Snooty developers should refer to `<HACKING.md>`__ for documentation on internals and
how to work on the Snooty Parser.
1 change: 1 addition & 0 deletions docs/flowchart.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6531ca9

Please sign in to comment.