Import docs from Confluence#1
Merged
Merged
Conversation
daniel-miller
commented
May 28, 2026
daniel-miller
commented
Contributor
- docs: import toolkit docs from confluence
- chore(ci): add lint, link, spell, and commit workflows
- docs: add contributing and onboarding guides
- docs(nav): populate root SUMMARY across all spaces
- refactor(contributors): move utility-components into toolkits
- docs(releases): rename autogenerated files; drop archive page
- docs(surveys): migrate legacy file-share images for font and color page
- chore(topics): drop stale duplicate SUMMARY orphan
- docs(contributors): site-wide content cleanup
- docs(topics): site-wide content cleanup
- docs(other): cleanup across guides, developers, staff, embeds, releases, operations
Add GitHub Actions and configuration for: * lychee link check (PRs, push to master, weekly cron) * markdownlint-cli2 style check * cspell spell check with project vocabulary * commitlint enforcing Conventional Commits on PR titles Plus an EditorConfig and a pull-request template that mirrors the checklist in CONTRIBUTING.md.
* CONTRIBUTING.md covers conventions: commit messages, frontmatter, alt text, file naming, terminology, SUMMARY.md updates, and a pre-merge checklist. * CONTRIBUTORS.md is one-page onboarding: spaces map, GitBook sync flow, local lint commands, where things live.
Root SUMMARY.md was a single placeholder entry. Replace with a directory of the eight spaces (topics, guides, developers, contributors, releases, starters, operations, staff) so the repo is navigable from the root.
Internal vocabulary moved from Components to Toolkits months ago. The contributors/getting-started/components/ tree was the last place still using the old name, with Utility Components → Metadata and Setup as live content underneath. * Move metadata.md to contributors/toolkits/metadata.md * Move setup/ to contributors/toolkits/setup/ * Drop the now-empty getting-started/components/ tree * Update contributors/SUMMARY.md to reference the new paths under Toolkits Also replace hardcoded `C:\Base\Repos\InSite\...` paths and developer names in metadata.md with `<InSiteRepoRoot>` and `<LocalBackupsFolder>` placeholders so the docs work on any machine.
The GitBook web editor names new pages `README (N).md`. Rename the five accumulated release pages to descriptive kebab-case slugs and update releases/SUMMARY.md to match: * `README (1).md` -> june-20-welcome-to-the-changelog.md * `README (2).md` -> july-16-version-25.4-is-live.md * `README (2) (1).md` -> july-9-version-25.4-in-pre-release.md * `README (3).md` -> sep-10-version-25.5-is-live.md * `README (4).md` -> oct-29-version-25.6-is-live.md Also delete `releases/archived-release-notes.md`. Older notes are maintained on the public website and nobody reads the archive. The "full release notes" redirect from the v25.6 page (previously a HubSpot tracking URL) is removed alongside.
The Changing Fonts and Colors page referenced eight images via `../../../files/sites/global/...` paths — a legacy public file share on e02.insite.com that the rest of the docs no longer use. * Fetch the eight images from the legacy host * Place them under topics/.gitbook/assets/ with descriptive kebab-case names (font-color-html-tag-example-1.png, survey-bold-italic-source.png, ...) * Rewrite the page to: * Reference the new local paths * Add descriptive alt text to each image * Replace inline backslash-escaped HTML with fenced `html` code blocks * Restructure the two main sections into proper numbered steps * Cleanly convert two setext (===/---) headings to ATX The page no longer needs the lycheeignore workaround for the legacy file path, so that pattern is omitted from the configuration in the CI tooling commit.
topics/_SUMMARY_.md was a 274-line duplicate of topics/SUMMARY.md referencing a never-shipped Jobs section (topics/jobs/overview.md and friends — files that never landed in the repo). The live nav is topics/SUMMARY.md.
Bulk improvements to the contributors space, layered:
* Populate stub READMEs in toolkits/{security,reports,workflows,
standards,standards/ideas} with intros and child link lists.
* Fill the architecture/ and domains/ "Coming soon" placeholders
with concrete planned-content lists so contributors know what
to expect.
* Add YAML `description:` frontmatter to pages that lacked it
(~90% coverage), auto-extracted from each page's first paragraph
with hand tuning where the extraction was poor.
* Replace `alt=""` on figure tags with descriptive alt text derived
from image filenames; hand-tune architecture.md (5 diagrams),
git-branches.md, and git-pull-requests.md (6 GitHub UI shots) so
alt text explains what the diagram shows rather than the filename.
* Apply markdownlint auto-fixes: list style (`-` to `*`), trailing
spaces, ordered-list prefixes, blanks around lists and headings,
heading punctuation.
* Fix spelling typos picked up by cspell across all pages.
* Repair the broken cross-reference in security/setting-up-new-
organizations/README.md ("broken-reference/" -> the actual sibling
page).
* Remove the duplicate "Using api/react/queries" stub heading in
conventions/introduction.md that produced an empty section.
* Unlink the dangling `#admin-portal` anchor in
implementation/front-end/insite.ui/README.md (no matching heading
exists on the page).
Bulk improvements to the customer-facing help center, layered:
* Populate ~24 section README and overview stubs (assessments/
editing-forms, surveys/{configure-survey-details,survey-responses,
survey-messages,question-configuration}, messages/*, records/*,
events/*, courses/*, sites/*, standards/*, cases/*) with two- to
three-sentence intros and child link lists derived from
topics/SUMMARY.md.
* Fill 12 thin leaf content pages with frontmatter, a `> Draft`
callout, and a "this page will cover" scope list — placeholders
for a subject-matter expert to author. No fabricated steps.
* Add YAML `description:` frontmatter to ~200 customer-facing pages
that lacked it, auto-extracted from each page's first paragraph
and trimmed to the last complete sentence (no mid-sentence
ellipses).
* Hand-tune the description on every customer-facing landing page
(assessments/contacts/courses/events/messages/records/sites/
standards/surveys overviews) so search snippets read as
action-keyword summaries rather than duplicates of the first
paragraph.
* Replace `alt=""` on figure tags with descriptive alt text derived
from image filenames, and add alt text to inline  markdown
images that markdownlint flagged.
* Apply markdownlint auto-fixes site-wide: list style, trailing
spaces, ordered-list prefixes, blanks around lists and headings,
heading punctuation, hard tabs.
* Convert two setext (===/---) headings to ATX in
surveys/question-configuration/changing-fonts-and-colors.md.
* Restructure list spacing in assessments/specifications-forms/
adding-timers-to-tabs.md and events/classes-for-exams/
login-credentials-for-exam.md so numbered lists no longer reset
mid-procedure.
* Fix spelling typos across all pages (uplaod, themslevles,
supressed, slect, separted, propogated, Conent, Newsleter,
Identifire, exisiting, deprecated misspellings, etc.).
* Fix "tool kit" -> "toolkit" in contacts/overview.md (the only
remaining instance in the repo).
* Rename the topics nav section "Sales" -> "Billing" to align with
the internal toolkit name; expand sales.md with a short overview.
…es, operations
* Add YAML `description:` frontmatter to pages that lacked it across
guides/, developers/, staff/, starters/, embeds/, releases/, and
operations/, auto-extracted from first paragraphs.
* Populate staff/SUMMARY.md with the existing Job descriptions
section (Technical Job Descriptions intro + four role pages) so
the staff space nav matches reality.
* Replace `alt=""` on figure tags with descriptive alt text derived
from image filenames; hand-tune the heavy walkthrough images in
guides/role-based-guides/.
* Fix the "is demonstrates" copy bug in instructor-walkthrough.md.
* Disambiguate the duplicate `# Conditions d'utilisation` heading
in embeds/fr.md by appending the page scope to one of them.
* Fix spelling typos and apply markdownlint auto-fixes.
* Populate the previously empty `contributors/implementation/
{back-end,front-end}` and `developers/api-v1/api-reference`
READMEs with intros and child link lists. (The contributors
pieces of this commit landed in the earlier contributors
cleanup.)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.