-
Notifications
You must be signed in to change notification settings - Fork 66
Surface known limitations more prominently in compiler docs #1033
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
The compiler index page already mentions that known bugs and limitations exist and links to the issue tracker, which is good. However, the detailed known-limitations doc (docs/external/src/appendix/known-limitations.md) that actually lists specific limitations is marked draft: true, so it doesn't render in the published docs. The appendix index linking to it is also marked draft: true.
This means the detailed information exists but isn't reachable. Pioneer developers are discovering these limitations during development rather than upfront.
I think we should remove the draft: true flags and make sure the index page links to the full known-limitations page directly, not just to the issue tracker.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation