Skip to content

Add v2 Supported File Formats page; mark existing file-support as v1.26#111

Open
keitawf wants to merge 2 commits into
masterfrom
v2.5-file-formats
Open

Add v2 Supported File Formats page; mark existing file-support as v1.26#111
keitawf wants to merge 2 commits into
masterfrom
v2.5-file-formats

Conversation

@keitawf

@keitawf keitawf commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #110. The only file-format documentation on the site described Nanome 1.26 — the FAQ's "exhaustive list" even included formats v2 dropped (.ccp4, .dsn6, .psf, .nanome).

Changes

  • New page docs/nanome_web/fileformats.md under Nanome Web: the v2 supported formats through 2.6.0 — per-format import/export capability, trajectory playback, import/export surfaces, limitations, and per-version history. Adapted from the internal reference doc; dropped the internal-only "go-forward rule" and a dead cross-reference to a nonexistent Guidance page.
  • FAQ: added a "What file formats does Nanome v2 support?" answer that links the new page, and tagged both existing answers (v1.26) with a v2 pointer.
  • v1.x pages (navigating, navigation/menus, howto): tagged the format lists (v1.26) and pointed to the v2 page.

Notes

  • The new page is under Nanome Web per the request, though its content spans the whole v2 platform (XR client, MARA, WorkspaceAPI), not just the web app. Easy to relocate if you'd rather it live elsewhere.
  • Content is faithful to the source reference, including the capability-key emoji legend (👁 ▶️ ✏️ 💾).

Verification

npm run docs:build passes with no dead links. All internal links and anchors validated with a script, including the FAQ deep-link into #trajectory-molecular-dynamics (VitePress validates page paths but not anchors). Previewed on localhost; the new page and both tagged FAQ answers render correctly.

🤖 Generated with Claude Code

The only file-format documentation on the site described Nanome 1.26 (the
"exhaustive list" even included formats v2 dropped, e.g. .ccp4/.dsn6/.nanome).

- New docs/nanome_web/fileformats.md: the v2 supported formats (through 2.6.0),
  adapted from the internal reference — import/export capability per format,
  trajectory playback, surfaces, limitations, and per-version history. Dropped
  the internal-only "go-forward rule" and a dead cross-reference.
- FAQ: add a "What file formats does Nanome v2 support?" answer linking the new
  page; tag both existing answers "(v1.26)" with a v2 pointer.
- Tag the v1.x format lists (navigating, menus, howto) "(v1.26)" and point to
  the v2 page.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@keitawf
keitawf requested a review from ajm13 July 21, 2026 17:23
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 21, 2026

Copy link
Copy Markdown

Deploying nanome-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8f851d5
Status: ✅  Deploy successful!
Preview URL: https://4c6f53d4.nanome-docs.pages.dev
Branch Preview URL: https://v2-5-file-formats.nanome-docs.pages.dev

View logs

- Nanome Web / Loading Structures: note the web app accepts the full range of
  file types and link the Supported File Formats page.
- Main Panel / Entries and Components: clarify that XR loads structures by PDB
  code from the RCSB, while other file types are loaded from the web app; link
  both the web loading page and the file formats list.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Stahnke

Stahnke commented Jul 22, 2026

Copy link
Copy Markdown

Heads up: the new v2 file-formats table here inherited a few extensions from the wiki doc that WorkspaceAPI doesn't actually parse (Alex flagged it; verifiable by grepping IoFormat(...) in WorkspaceAPI). I just corrected the wiki source (rev 16); the same fix applies to this page:

  • mmCIF / PDBx (line 130): drop .mcif and .bcif. Only .cif/.mmcif are registered (new IoFormat("mmcif", "cif")).
  • SDF (line 131): drop .sd and .mol. Only .sdf.
  • Delete the MOL / MOL2 row (line 132). There is no MDL mol/mol2 loader.
  • Prose (line 28): drop MOL/MOL2 from the imported-structures list.

Full recognized set (with real aliases): pdb/ent, mmcif/cif, sdf, pdbqt, pqr, mae, moe, pse, xyz, gro, xtc, trr, dcd, dx, fasta(fa/faa/seq), smi/smiles, molz. (The older v1.26 lists are a separate question.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants