chore(doc): align documentation structure and fix validation errors#135
Merged
chore(doc): align documentation structure and fix validation errors#135
Conversation
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
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.
Walkthrough - Aligning Docgraph Requirements
I have aligned the documentation structure with the updated
docgraph.tomlrules and resolved all linting errors.Changes
1. Configuration Updates (
docgraph.toml)fromtotoforFR,NFR,MOD,ACT,IF, andADRto match the document structure (outgoing links).UCto link toACT,IF, andFR. Added rule forFRto referenceIF. Added rule forCCto link toADR.NFRto constrainCC.2. Template Refinements
doc/templates/constraint.mdto use H2 headers (## {Name}) instead of expecting H1/H2 mix.module.md,usecases.md,non-functional.md, andcross-cutting.mdto match patterns with optional descriptions (e.g.,[* (*)](*#*) {description}).usecases.mdpattern from*#*_to*#*to correctly match node IDs likeACT_CI.3. Content Updates
module.md): Populated emptyRealizessections in sub-modules (MOD_CORE_RULES,MOD_CORE_GRAPH,MOD_LSP_SERVER) with relevant functional requirement links.development.mdto remove the top-level H1 header and use H2 headers for all nodes, matching the new template.quality.mdto use H2 header.thin-handlers.md,dependency-rule.md, etc., to match the new template structure (movedDecided bybeforeReflected in).Reflected inlists where appropriate.ActorsandInterfacessections toci.md.DG004errors inlsp.mdandmodule.md.Verification Results
Automated Checks
docgraph checkpassed with 0 errors.docgraph graphgenerated the dependency graph successfully.