SIM 5264 hamonize and resturcture Simplifier docs#80
Open
ArdonToonstra wants to merge 21 commits into
Open
Conversation
Consolidate and update the Quality Control documentation: remove the legacy simplifierQualityControl.rst and migrate/refresh content across introduction, syntax and examples pages. Added images and a Professional-plan note, renamed and restructured the QC section, expanded example rules (ValueSet id/name and extension id checks), and clarified validator options (default Firely .NET SDK, optional netsdk flavor, plus java-validate action for beta users). Also updated TOC to remove the old entry and reflect the new pages.
Move the quality_control_syntax docs into a new quality_control directory and update references. Updated data_governance_and_quality_control.rst to point to quality_control/quality_control_syntax; renamed files (actions.rst, examples.rst, fhir-actions.rst, generic-properties.rst, introduction.rst, quality_control_syntax.rst) preserving content (100% similarity) so Sphinx links remain correct.
Rename data_governance_and_quality_control/quality_control/quality_control_syntax.rst to quality_control.rst and update the toctree entry in data_governance_and_quality_control/data_governance_and_quality_control.rst to point to the new filename. Keeps documentation filenames consistent and avoids broken links.
Restructure documentation: introduce a new adding_content section and a package_releases area, moving and renaming many files from the old data_governance_and_quality_control tree into package_releases, quality_control, and getting_started. Add new pages (metadata-expressions, firely-terminal, upload-resources, other-git-repositories, package_feeds) and a package_releases index/TOC. Update internal links and image paths, adjust small content bits (Bake -> Bake pipeline note, contact image filename), and remove the legacy data_governance_and_quality_control index and related obsolete files.
Reorganize and clean up the Implementation Guide documentation: remove legacy ig_help subpages and consolidate their content into two new pages (page_setup.rst and rendering_fhir.rst). Rewrite and condense create_your_first_ig.rst, add a search page note to customize_your_ig.rst, and update implementation_guide.rst to include the new pages and moved simplifierPlantUML. Also move bake documentation into package_releases/bake and update feature and package_releases indices to reflect the new locations. Overall this tidies the doc structure and improves navigation/TOC entries.
Unify and rephrase pricing notices in multiple documentation pages for consistency and clarity. Replaced inline backticked links with a uniform "See the pricing page for details." phrasing and adjusted availability wording (e.g. "available from..." / "available on...") across the following RST files: adding_content/github.rst, administration/simplifierOrganizationPortal.rst, administration/simplifierTeamManagement.rst, getting_started/simplifierProjects.rst, implementation_guide/customize_your_ig.rst, implementation_guide/ig_management.rst, implementation_guide/simplifierPublishedGuides.rst, package_releases/bake/bake.rst, quality_control/quality_control.rst. This is a stylistic/documentation change only.
Restructure and expand the Published Guides documentation. Adds an anchor and a new "Publishing your guide" heading, clarifies that publishing creates a versioned snapshot (static site) versus the default live rendering, and provides a clear numbered workflow tied to package releases. Explains differences between guide and package versioning (string vs semver, overwritable vs final), gives examples of overwrite vs new package scenarios, documents Publish Guide wizard options, and adds cross-references to package management and package releases. Removes older wording and reorganizes content for clarity.
Change the section heading from "Adding content to your project (sync strategy)" to "Adding and syncing content" and update the index reference to match. This improves clarity and consistency in the documentation (files updated: adding_content/adding_content.rst, index.rst).
Correct various internal and external links across the docs to fix broken/misrouted references. Changes include: - adding_content/api.rst: update package documentation anchor to #create-releases. - getting_started/simplifierPersonalContent.rst: point IG create/edit link to implementation_guide/create_your_first_ig.html. - getting_started/simplifierProjects.rst: use local simplifierPersonalContent.html for personal portal link and replace registry link with https://registry.fhir.org. - getting_started/simplifierResources.rst: update personal menu link to simplifierPersonalContent.html#user-portal. - implementation_guide/ig_management.rst: fix JIRA portal URL to the full https://firely.atlassian.net/... URL. These updates ensure links resolve correctly for readers.
Delete the entire develop/quality-control documentation and its subpages. Removed files include examples, rule-actions (and its include/predicate/same/unique/unit-testing/validate pages), rule-filters, rule-properties, and structure documents.
Replace occurrences of "FhirPath" with "FHIRPath" across documentation for consistency. Also update the Hl7.DSTU2.FHIRPath package reference and apply minor capitalization fixes (e.g., Firely Server, FHIRPath playground).
Convert WCAG 2.0 reference URLs from http to https in accessibility.rst and add a trailing slash to the main WCAG20 link. This makes the WCAG anchor links secure/canonical and helps avoid mixed-content or redirect issues when referencing the W3C resources.
Correct spelling and grammar across multiple .rst docs to improve clarity and consistency. Changes touch accessibility.rst, adding_content/*, administration/*, features/*, getting_started/*, implementation_guide/*, index.rst, package_releases/*, and simplifierReleaseNotesOlder.rst. Examples include fixes like 'Simplfier'→'Simplifier', 'feautures'→'features', 'tranform'→'transform', 'webbased'→'web-based', and various other punctuation and wording corrections.
Standardize capitalization and correct typos across documentation (Dependencies.rst, FAQs.rst, accessibility.rst, adding_content/github.rst, metadata-expressions.rst, features/*, yamlgen pages, simplifierIntro.rst, simplifierReleaseNotesOlder.rst). Notable fixes: 'Github' -> 'GitHub', 'Javascript' -> 'JavaScript', 'Yaml' -> 'YAML', 'depencies' -> 'dependencies', and a few wording/formatting tweaks. Also add sphinx-reredirects==0.1.6 to requirements.txt (last version supporting RTD Python 3.7) and normalize EOF/newline.
Update docs config to support the site restructure: bump copyright year to 2026, add 'sphinx_reredirects' to Sphinx extensions, and introduce a redirects mapping that computes relative redirect URLs using posixpath for moved/renamed doc pages. Also add the pinned 'sphinx-reredirects==0.1.6' requirement (last version supporting RTD's Python 3.7) to requirements.txt.
Update Read the Docs build to use Python 3.12 and remove the strict pin on sphinx-reredirects in requirements.txt. The previous pin was kept for compatibility with RTD's Python 3.7; with the RTD Python version upgraded, allow the redirects package to float to newer releases.
Fix capitalization and terminology in documentation for consistency and correctness: change 'Oauth' to 'OAuth', 'Powershell' to 'PowerShell', and variants of 'MacOS'/'MAC OS' to 'macOS' across adding_content/github.rst, features/simplifierFirely-server.rst, and simplifierReleaseNotesOlder.rst.
Remove placeholder migration TODO notes from FQL docs and expand the Quality Control introduction with concrete example rule series. Changes: - Removed redundant "*(migration TODO)*" note blocks from features/fql/examples.rst and features/fql/syntax.rst. - Rewrote quality_control/introduction.rst to clarify the free, minimal, and recommended rule series and to include sample YAML rule definitions (parse, id checks, explicit-version, resource validation, unique canonicals, include manifest, and additional recommended checks). This replaces placeholder notes with actionable examples and clearer guidance for project rule configuration.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.