Skip to content

docs: document frozen extras and their planned replacements - #37

Merged
mahach666 merged 1 commit into
mainfrom
docs/freeze-extras
Nov 12, 2026
Merged

mahach666 merged 1 commit into
mainfrom
docs/freeze-extras

Conversation

@mahach666

Copy link
Copy Markdown
Contributor

What changes and why

IfcIO's job is reading and writing IFC. Several extras grew around it; this PR states which of them are frozen (bug fixes only, no new features or options) and what is planned to replace them, so contributors and users know where new work goes.

  • README.md: new "Scope and frozen features" section.
    • HTML viewer (IfcHtmlViewerExporter, ifcio view): viewing moves to IOViewer through a planned IfcIO.Scene adapter over the planned shared IOScene model.
    • GLB and OBJ export (IfcGlbExporter, IfcObjExporter): a shared GLB writer is planned in IOScene.Formats.
    • Clash, measure, grids, diff and BCF (IfcClashDetector, IfcClashGrouper, IfcMeasureEngine, IfcGridSystem, IfcDiffEngine, BcfArchive, BcfZipExporter): planned to move to an IOCoord package.
    • IFC work-schedule (4D) sequence logic stays in IfcIO.
    • None of the replacement packages is published yet. Frozen features stay available and are removed no earlier than IfcIO 1.0, and only after a published replacement exists.
  • CHANGELOG.md: one line under [Unreleased] / Changed pointing to the new README section.
  • .github/dependabot.yml (new): weekly update checks for NuGet and GitHub Actions.

No source, API or package changes.

Tests

  • Build and tests: not run (no code changes).
  • dependabot.yml: not validated.
  • README links: not checked beyond the IOViewer repository being public.

Notes

  • Merge order: no dependencies. It touches no code and there are no other open IfcIO PRs, so it can merge on its own at any time.
  • The Dependabot config is not documentation and has no CHANGELOG entry; it can be split into its own PR if preferred.
  • Follow-up: when IfcIO.Scene, IOScene, IOScene.Formats or IOCoord is published, update the "None of these packages is published yet" sentence and link the package.

@mahach666
mahach666 merged commit e77c859 into main Nov 12, 2026
2 checks passed
@mahach666
mahach666 deleted the docs/freeze-extras branch November 12, 2026 21:48
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.

1 participant