diff --git a/.gitignore b/.gitignore index a0fed77..ad9597d 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -HqdmPatterns1.code-workspace +HqdmPatterns.code-workspace diff --git a/HqdmPatterns.code-workspace b/HqdmPatterns.code-workspace new file mode 100644 index 0000000..876a149 --- /dev/null +++ b/HqdmPatterns.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": "." + } + ], + "settings": {} +} \ No newline at end of file diff --git a/README.md b/README.md index 59c6bc4..8bf1c3d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# HqdmPatterns1 +# HqdmPatterns ## Documentation on implementation patterns for HQDM A markdown-based documentation pack on implementation patterns for the use of the Topl Level Ontology (TLO)-based integration data model created by Dr Matthew West called ["HQDM"](https://www.oreilly.com/library/view/developing-high-quality/9780123751065/), using ```mkdocs material``` and related plugins. The documentation is experimantal and will be updated when capacity allows. diff --git a/docs/introducing_hqdm/basic _intro_to_hqdm.md b/docs/introducing_hqdm/basic_intro_to_hqdm.md similarity index 100% rename from docs/introducing_hqdm/basic _intro_to_hqdm.md rename to docs/introducing_hqdm/basic_intro_to_hqdm.md diff --git a/mkdocs.yml b/mkdocs.yml index 6b20b50..4991070 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,7 @@ copyright: Copyright © 2023 Critical Insight Security Ltd extra: social: - icon: fontawesome/brands/github - link: https://github.com/ClimbingAl/HqdmPatterns1 + link: https://github.com/ClimbingAl/HqdmPatterns extra_css: - stylesheets/extra.css @@ -71,41 +71,41 @@ markdown_extensions: nav: - 'index.md' - - 'Introducing HQDM': - - introducing_hqdm\basic _intro_to_hqdm.md - - introducing_hqdm\top_level_type.md + - 'Introducing_HQDM': + - introducing_hqdm/basic_intro_to_hqdm.md + - introducing_hqdm/top_level_type.md - 'Fundamental Relations': - - fundamental_elements\relations.md - - fundamental_elements\parts.md - - fundamental_elements\sets.md - - fundamental_elements\order.md + - fundamental_elements/relations.md + - fundamental_elements/parts.md + - fundamental_elements/sets.md + - fundamental_elements/order.md - 'Individual': - individual/individual.md - individual/individual_LM5.md - individual/individual_queries.md - 'Activity and Association': - 'Association' : - - association\association.md - - association\associationEagleCrew.md + - association/association.md + - association/associationEagleCrew.md - 'Activity' : - - activity\activity.md - - activity\activityEagle.md + - activity/activity.md + - activity/activityEagle.md - 'Sign and Pattern': - - signs_and_patterns\what_are_signs.md - - signs_and_patterns\sign.md - - signs_and_patterns\sign_options_by_diagram.md - - signs_and_patterns\patterns.md - - signs_and_patterns\sign_and_pattern.md - - signs_and_patterns\sign_and_pattern_apollo_example.md + - signs_and_patterns/what_are_signs.md + - signs_and_patterns/sign.md + - signs_and_patterns/sign_options_by_diagram.md + - signs_and_patterns/patterns.md + - signs_and_patterns/sign_and_pattern.md + - signs_and_patterns/sign_and_pattern_apollo_example.md - 'System and System Component': - - system\system.md - - system\system_component.md + - system/system.md + - system/system_component.md - 'Properties and Qualities': - - properties\properties.md + - properties/properties.md - 'Levels of Reality': - - levels_of_reality\multiple_inheritance.md - - levels_of_reality\types_of_states.md + - levels_of_reality/multiple_inheritance.md + - levels_of_reality/types_of_states.md - 'Implementation Guidance': - - implementation_guidance\managing_immutable_data.md - - implementation_guidance\model_mapping_pro,cess.md + - implementation_guidance/managing_immutable_data.md + - implementation_guidance/model_mapping_process.md