Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,7 @@ jobs:
run: npm run test:suggestions && npm run suggestions:check
- name: Verify frozen manuals
run: npm run test:archives
- name: Install browser for editor checks
run: npx playwright install --with-deps chromium
- name: Verify full-page editor and complete Markdown corpus
run: npm run test:editor
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Corrections, clearer explanations, and missing documentation are welcome.

## Suggest a correction

When **Suggest a change** is available on a published page, choose a passage,
edit its wording, review it, and send. You do not need a GitHub account or
Markdown knowledge. Use **Describe a problem** for missing information or a
larger change. Suggestions and explanations are public and reviewed before
Choose **Edit this page** to edit the full document, including paragraphs,
headings, lists, links, and tables. Review the highlighted changes and send. You do not need a GitHub account or
Markdown knowledge. Use **Describe a problem** if you would rather explain a change
than edit the page. Suggestions and explanations are public and reviewed before
publication. Save the receipt link if you want to check progress.

For contributors who already use GitHub, you can also open a
Expand All @@ -21,7 +21,7 @@ alternative for people who already have an account.

## Edit a page on GitHub

Use **Edit page** at the bottom of a published article. GitHub will guide you
Use **Edit on GitHub** at the bottom of a published article. GitHub will guide you
through proposing the change. Contributors without write access can submit the
change from a fork as a pull request.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ npm run check

## Contributing

When enabled, **Suggest a change** lets readers edit a passage and send it for
review without a GitHub account. **Describe a problem** accepts broader reports.
When enabled, **Edit this page** opens a full-page Milkdown editor. Readers can
send changes for review without a GitHub account. **Describe a problem** accepts reports.
GitHub editing remains available for experienced contributors. See
[CONTRIBUTING.md](CONTRIBUTING.md).

The account-free service requires separate Cloudflare and GitHub App setup;
see [setup and operations](services/suggestions/README.md). It stays disabled
until configured. Run `npm run test:suggestions` for delivery and source-mapping
tests, and `npm run suggestions:check` to verify the Worker bundle.
tests, `npm run test:editor` for corpus and browser checks, and `npm run suggestions:check` to verify the Worker bundle.

## Manuals shipped with Vizard

Expand Down
7 changes: 3 additions & 4 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
// @ts-check
import { defineConfig } from 'astro/config';
import { unified } from '@astrojs/markdown-remark';
import starlight from '@astrojs/starlight';
import suggestionPassages from './src/lib/suggestions/remark.mjs';
import { revision, enabled } from './src/lib/suggestions/config.mjs';
import sitemap from '@astrojs/sitemap';

const isVercel = process.env.VERCEL === '1';

// https://astro.build/config
export default defineConfig({
markdown: { processor: unified({ remarkPlugins: [[suggestionPassages, { revision, enabled }]] }) },
site: isVercel ? 'https://vizard-docs.vercel.app' : 'https://plmn95.github.io',
base: process.env.VIZARD_DOCS_BASE || (isVercel ? '/' : '/vizard-docs'),
integrations: [
sitemap({ filter: (page) => !/\/(edit|suggestion)(\/|$)/.test(new URL(page).pathname) }),
starlight({
title: 'Vizard Documentation',
description: 'Documentation for the Vizard video synthesizer.',
Expand All @@ -21,6 +19,7 @@ export default defineConfig({
'./src/styles/vizard.css',
],
components: {
PageTitle: './src/components/PageTitle.astro',
SiteTitle: './src/components/SiteTitle.astro',
Footer: './src/components/ManualFooter.astro',
EditLink: './src/components/GitHubEditLink.astro',
Expand Down
Loading
Loading