Summary

Add an Introduction page with some high-level information.

Review Request #11705 — Created July 6, 2021 and submitted July 11, 2021, 3:40 a.m.

Information

Owner

chipx86

Repository

DiffX

Branch

master

Bugs

Depends On

~~11704~~

Reviewers

Groups

diffx

People

Description

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.

Testing Done

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

Commits

Summary	ID
Add an Introduction page with some high-level information. 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).	a98cc5905090bbd3c8f8d220d9dfe3824ebb5713

Summary

Add an Introduction page with some high-level information.

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).

a98cc5905090bbd3c8f8d220d9dfe3824ebb5713

Issues

Description	From	Last Updated
2016?	david	July 6, 2021, 10:36 p.m.

flake8 passed.

JSHint passed.

docs/spec/index.rst (Diff revision 1)

The issue has been resolved. Show all issues

2016?

chipx86 July 6, 2021, 6:18 p.m.

Grabbed from the conf.py, when I originally wrote the first draft of the spec. Figure it's better to backdate than not?

david July 6, 2021, 10:08 p.m.

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

Depends On:: ~~11704 - Reorganize and improve upon the docs on sections and definitions.~~

Change Summary:

Updated the copyright date.

Commits:

	Summary	ID
	Add an Introduction page with some high-level information. 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).	8f145c0bdc147b06e68e15959788b0143b5390f1
	Add an Introduction page with some high-level information. 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).	a98cc5905090bbd3c8f8d220d9dfe3824ebb5713

Diff:

Revision 2 (+160 -28)

Show changes

	docs/conf.py
	docs/index.rst
	docs/spec/index.rst
	docs/spec/intro.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (1be6b28)