Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need a plan to handle WiX documentation when there are significant schema changes #7753

Open
barnson opened this issue Sep 24, 2023 · 1 comment
Assignees

Comments

@barnson
Copy link
Member

barnson commented Sep 24, 2023

Encountered at: wixtoolset/wix@HEAD

Detail:
A lot of the new non-reference doc on https://wixtoolset.org/docs/ will deal well handling multiple (mostly-compatible) versions of WiX. That is not true of the schema and API reference doc, even for (mostly-compatible) versions of WiX, mostly because we generate them; the schema doc comes from the .xsd schema files and the API doc from built assemblies. Two obvious options:

  • Version the reference doc (e.g., https://wixtoolset.org/docs/api/v5/wixtoolset.data/accessmodifier/). Biggest downside is that Docusaurus (v2, at least) would almost certainly choke.
  • Build them from v5 and annotate version-specific schema and API (e.g., Introduced in v5). That works well for additions (e.g., the new attributes available to naked files) but falls apart quickly for bigger changes. That means eventually we have to version anyway.
@barnson barnson added the triage label Sep 24, 2023
@barnson barnson self-assigned this Oct 3, 2023
@barnson barnson changed the title Need a plan to handle WiX v5 documentation Need a plan to handle WiX documentation when there are significant schema changes Apr 22, 2024
@BryanCrotaz
Copy link

Look at EmberJS docs for a really user friendly way to do this with all versions in one site and a drop-down at the top to choose the version. It is built by an open source docs builder that you could probably use.

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

No branches or pull requests

2 participants