Add an Introduction page with some high-level information.

Review Request #11705 — Created July 6, 2021 and submitted

chipx86
DiffX
master
11704
diffx

The index of the spec had some very loose, incomplete content, a
leftover from when there was just the Sections page.

That has now been moved into a new Introduction page, and has been
expanded upon considerably. This page has an overview of DiffX, a Scope
section explaining what DiffX is trying to address and trying not to do,
more information on file extensions and expectations, and a brief
summary of the general file format.

The index page no longer has freeform text, but it does have some
information about the spec itself (version, copyright, and Last Updated
date).

The front of the docs package also now shows an example and links to
examples, helping tie that all together.

Built the docs. Checked for build errors, spelling errors, and bad
links.

Summary
Add an Introduction page with some high-level information.
Description From Last Updated

2016?

daviddavid
david
  1. 
      
  2. docs/spec/index.rst (Diff revision 1)
     
     
    1. Grabbed from the conf.py, when I originally wrote the first draft of the spec. Figure it's better to backdate than not?

    2. Not that it really matters given the terms of copyright nowadays, but I think a general principle is that current is better than backdated.

  3. 
      
chipx86
chipx86
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to master (1be6b28)
Loading...