Skip to content

docs: narrow roadmap scope away from native CAD plugins#67

Merged
chrislyonsKY merged 1 commit intomainfrom
docs/narrow-cad-scope
Apr 20, 2026
Merged

docs: narrow roadmap scope away from native CAD plugins#67
chrislyonsKY merged 1 commit intomainfrom
docs/narrow-cad-scope

Conversation

@chrislyonsKY
Copy link
Copy Markdown
Owner

@chrislyonsKY chrislyonsKY commented Apr 20, 2026

Decision

abovepy is stepping back from the commitment to ship native plugins for AutoCAD Civil 3D, Carlson, and Bentley OpenRoads Designer / MicroStation. The LandXML surface export that was positioned as the shared feed into those plugins is also being wound down on the standard deprecation schedule.

This PR aligns the public roadmap, landing copy, and plugin README with that decision. No code, tests, or public API change in this PR.

What changes in docs

  • v2.2 — "CAD/Survey Export Formats" retitled to "Export Formats". LandXML and contour-DXF bullets dropped. Generic LAS and GeoTIFF entries stay.
  • v2.3 — Civil 3D plugin prototype removed; theme narrowed to "Analysis APIs".
  • v3.0 — No longer enumerates Civil 3D / Carlson / OpenRoads plugins. Open theme for now; only concrete commitment is the scheduled removal of to_landxml().
  • Non-Goals — explicit entry added: native CAD-platform plugins are out of scope. Generic file-format interop (GeoTIFF, LAS, GeoPackage) remains in scope.
  • Target Users — Surveyor and Civil Engineer primary-tool columns now reflect what abovepy actually supports (Python, QGIS, ArcGIS Pro) rather than tools we do not integrate with.
  • Platform Support — Civil 3D, Carlson, and ORD / MicroStation rows removed.
  • Landing page (docs/index.md) — LandXML dropped from the promoted export-formats list.
  • QGIS plugin READMEto_landxml() marked deprecated, scheduled for removal in v3.0.

Deprecation path for to_landxml()

The function shipped in v2.1.1 and is public API, so removal follows a normal deprecation window rather than a yank:

  1. v2.1.x (now) — no change. Function works as before. Docs stop promoting it.
  2. v2.2.0DeprecationWarning added in to_landxml() with removal target.
  3. v3.0.0to_landxml(), its tests, and the landxml_export.py example are removed. The scipy dependency is re-evaluated at that time.

Test plan

  • mkdocs build renders the updated roadmap and landing page without warnings.
  • Review the updated Non-Goals and Target Users tables for accuracy against what v2.1.x actually ships.

The roadmap previously committed abovepy to shipping native plugins for
Civil 3D, Carlson, and OpenRoads Designer / MicroStation, with LandXML
surface export positioned as the shared feed into those plugins. We are
not pursuing that CAD-plugin direction. This commit aligns the public
roadmap, landing copy, and plugin README with that decision.

Changes:
- v2.2 section retitled from "CAD/Survey Export Formats" to "Export
  Formats". Drops the LandXML and contour-DXF bullets; keeps the generic
  LAS and GeoTIFF entries.
- v2.3 section drops the Civil 3D plugin prototype and updates its theme
  to "Analysis APIs" only.
- v3.0 section no longer enumerates Civil 3D / Carlson / OpenRoads
  plugins. It now reads as an open theme, with the one concrete commitment
  being the scheduled removal of `to_landxml()`.
- Non-Goals gains an explicit entry stating native CAD-platform plugins
  are out of scope; generic file-format interop remains in scope.
- Target Users table updates Surveyor and Civil Engineer primary-tool
  columns to reflect what abovepy actually supports today (Python, QGIS,
  ArcGIS Pro) rather than tools we do not integrate with.
- Platform Support table drops the Civil 3D / Carlson / ORD rows.
- Landing page no longer lists LandXML among promoted export formats.
- QGIS plugin README marks `to_landxml()` as deprecated and scheduled
  for removal in v3.0.

`to_landxml()` itself remains in v2.1.x unchanged. The deprecation
warning lands in v2.2.0 and the function is removed in v3.0.0 per
the standard deprecation window.

No code, tests, or public API are modified in this commit.
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@chrislyonsKY chrislyonsKY merged commit 81f203b into main Apr 20, 2026
15 checks passed
@chrislyonsKY chrislyonsKY deleted the docs/narrow-cad-scope branch April 20, 2026 13:18
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.

2 participants