A Renewed SCNexus Website
The documentation site that served us for three years has been retired. The new site brings the product overview, documentation, changelog, blog and Workshop together in one place.
If you have visited this domain before, what you saw was a documentation site: a column of entries on the left, installation steps and format references in the middle, a sponsorship link in the footer. That was scnexus-docs, built on VitePress in 2023, and its job was to host documentation.
Over three years it took on more and more content, yet its structure remained that of a documentation site: the changelog was stacked into a single page in sequential order, and identifying what changed in a given version depended on your browser's find function; the download button pointed at GitHub Releases, with only a single link on the site itself; and what the application actually is never had a page that answered the question directly.
So this is a rebuild, not a change of appearance.
What the new site contains
The site is divided into the following sections, all reachable from the top navigation:
- Home — product overview, core capabilities, a preview of the client interface, community links, and a download button pointing at the latest version.
- Changelog — one record per version.
- Blog — announcements, releases, technical notes, community and guides, filterable by category. This post is an announcement.
- Documentation — the primary entry point for installation and usage.
- Workshop — browse projects on the web.
- Account — account-related settings.
Sponsorship, the privacy policy and the terms of service are all still here, and easier to find than before. The status page remains a separate site; the navigation keeps a link to it.
The changelog can now be browsed by version
Previously every version was collected in one long article, and the further back you went, the harder it was to search. Now each version has its own record, with the body divided into three fixed groups:
- Updates: what was added or changed;
- Fixes: what was repaired;
- Notes: known issues and things to check before upgrading.
The top of the page lets you switch between stable and snapshot releases. To confirm what changed in the first 0.1.0 snapshot, open that version — no scrolling required.
The documentation has not moved, only the way it reads
One point worth stating: the documentation content is still maintained in the scnexus-docs repository. Nothing was copied into the new site. Content is synchronized when the site is published, so a single edit keeps both sides consistent.
What changed is the layout: the left column groups pages under "Getting Started / Guides / Reference", the right column shows the table of contents for the current page, and the footer links to the previous and next pages. Finding the definition of a field used to require guessing which page it belonged to; browsing by group now gets you close enough to locate it.
The Workshop is now accessible on the web
Previously the only way to see what the Workshop contained was to open the client. You can now browse project descriptions, version history, supported formats and dependencies on the web, and decide whether to install.
This section requires signing in on the web. The client is unaffected.
Other changes
- Chinese and English: Chinese is the default language; English lives under
/en. Translations are still being filled in, and pages without one are marked explicitly rather than presenting Chinese text as English. - Light and dark: follows the system setting, and can also be switched manually.
- Mobile layout: the old documentation site required constant zooming on a phone; navigation, body text and tables are now reflowed for small screens.
What comes next
The site itself is only the front door; the content behind it still needs work:
- Fill in English content for documentation and the blog, so that
/enis no longer predominantly Chinese; - Connect project uploads for the Workshop, so project files can live on the site rather than only descriptions and version records;
- Support subscriptions to the changelog and blog, so there is no need to revisit the site to check.
Feedback
The site has just been rebuilt and will inevitably have gaps. If you find a broken link, a layout problem or outdated content, please open an issue on GitHub, or let us know in the QQ group or on Discord.
The old site is no longer updated; documentation is now reached through Documentation.
