Skip to content

Feedback for “Scriptura (working title)”: editorial pass (typos, dead Sentinel link, Alternatives formatting) #59

Description

@will-lamerton

Collecting the small copy and consistency problems in one place, separate from the substantive issues, so they can be fixed in a single editorial pass. Per How a Project Comes to Life, editorial PRs on typos, links and formatting are open to anyone and carry a light review bar, so this could just as easily be a PR. Happy to open one if that is easier.

Typos and broken sentences

  • Problem, item 4: "Most developers who start this abandon it before the feels right." A word is missing, presumably "it".
  • v1 scope, first bullet: "An editor built on the open scriptura sources," has a trailing comma, no predicate, and a lowercase project name. Every other bullet in that list is a complete phrase.
  • What it is not: "It is built on the existing base ." has a stray space before the full stop. (The substance of this bullet is also wrong, covered separately.)
  • Alternatives considered, fourth item: "Fork IntelliJ IDEA base" then "Even worst performance and even harder tech stack(java-based), even more restricted architecture for expansion , compare to VScode". This one needs a rewrite: it is missing the bold lead in and body structure the three bullets above it use, "worst" should be "worse", "compare to" should be "compared to", there is a space before a comma, a missing space before a parenthesis, and "VScode" should be "VS Code".

Consistency with the rest of the docs

  • The link to /collective/whitepapers/sentinel in Composition resolves to nothing. There is no Sentinel whitepaper file in content/collective/whitepapers/; Sentinel is a shipped project and is linked elsewhere as Nano-Collective/sentinel. Worth noting DocsForest has the same dead link in several places, so this may be a site wide leftover from when that page existed rather than something this whitepaper introduced. Fixing it here regardless.
  • Architecture writes "C++ QT" and Alternatives writes "VScode". The repo and the vendors use "Qt" and "VS Code".
  • The repository link in the intro is bare markdown of the URL itself. Elsewhere the whitepapers link with the project name as the anchor text.

Structure

  • The Architecture heading sits above three sentences, then a ### Why this shape is the point subheading below it. Given how thin the parent section is, the subheading currently reads as the main content. This resolves itself if Architecture is expanded (covered separately).
  • Next steps ends with "A repository is created under Nano-Collective" as a statement of fact in the present tense, sitting outside the checklist above it. It reads as though the transfer has happened. It has not; the repo is at jason1015-coder/scriptura. It should be a checklist item.

None of this affects the argument. It is a tidy up so the document reads at the same level as the code behind it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions