docs: the tools' names in TitleCase
Prose names are PaperSpec, PaperDesk, PaperClaim and so on; commands, packages and paths stay lowercase. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014zNf4shD4zaCKLucZWPYL9
This commit is contained in:
24 files changed
+111
-111
No files matched your search
+4
-4
@@ -1,18 +1,18 @@
|
||||
# Guides
|
||||
|
||||
These guides explain paperspec to someone meeting it for the first time.
|
||||
These guides explain PaperSpec to someone meeting it for the first time.
|
||||
They serve three readers: a newcomer who has not seen the problem before, an implementer who will write a reader, writer, converter or checker, and an expert who knows the neighboring standards.
|
||||
The [specification](../spec/README.md) says exactly what each format is.
|
||||
The guides say what each format is for, with examples drawn from the fixtures.
|
||||
|
||||
| Guide | For |
|
||||
| --- | --- |
|
||||
| [Overview](overview.md) | What paperspec is, who it serves, and how its parts fit together. |
|
||||
| [Overview](overview.md) | What PaperSpec is, who it serves, and how its parts fit together. |
|
||||
| [Concepts](concepts.md) | The ideas behind the formats, one at a time, each with a real example. |
|
||||
| [Walkthrough](walkthrough.md) | One paper, from a flawed first reading to a corrected, reviewed and signed document. |
|
||||
| [Examples](examples.md) | Things to run: checking hashes by hand, reading a package with a few lines of Python, querying a database. |
|
||||
| [Rationale](rationale.md) | Why the formats look the way they do, and the questions they leave open. |
|
||||
| [Comparison](comparison.md) | How paperspec compares with JATS, TEI, W3C Web Annotation and other schemas. |
|
||||
| [Comparison](comparison.md) | How PaperSpec compares with JATS, TEI, W3C Web Annotation and other schemas. |
|
||||
| [*FAQ*](faq.md) | Short answers to the questions people ask first. |
|
||||
| [Glossary](glossary.md) | Every term, in a sentence. |
|
||||
|
||||
@@ -27,7 +27,7 @@ Next, run the section "Test your implementation against a vector" in the example
|
||||
Check your work against the [vectors](../vectors/README.md) and the [fixtures](../fixtures/README.md).
|
||||
Chapter 22 of the specification defines conformance.
|
||||
|
||||
**Expert.** Read the overview for scope and for what paperspec is not, then the comparison for how it differs from existing standards.
|
||||
**Expert.** Read the overview for scope and for what PaperSpec is not, then the comparison for how it differs from existing standards.
|
||||
After that, read the rationale for the reason behind each rule and the questions it leaves open.
|
||||
It ends with a list of limits.
|
||||
Section 0.4 of the specification and [registry/formats.json](../registry/formats.json) give the status of each format: the version is 0.1.0, and each format is `candidate` or `provisional`.
|
||||
Reference in new issue
Block a user