fix: Update markdown link syntax to include URL format for clarity
This commit is contained in:
@@ -8,20 +8,20 @@
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Overview](#overview)
|
||||
- [System Architecture](#system-architecture)
|
||||
- [Technology Stack](#technology-stack)
|
||||
- [Directory Structure](#directory-structure)
|
||||
- [Core Components](#core-components)
|
||||
- [Security Architecture](#security-architecture)
|
||||
- [Data Flow](#data-flow)
|
||||
- [Deployment Architecture](#deployment-architecture)
|
||||
- [Development Workflow](#development-workflow)
|
||||
- [Testing Strategy](#testing-strategy)
|
||||
- [Build & Release Process](#build--release-process)
|
||||
- [Extensibility](#extensibility)
|
||||
- [Known Limitations](#known-limitations)
|
||||
- [Maintenance & Updates](#maintenance--updates)
|
||||
- Overview
|
||||
- System Architecture
|
||||
- Technology Stack
|
||||
- Directory Structure
|
||||
- Core Components
|
||||
- Security Architecture
|
||||
- Data Flow
|
||||
- Deployment Architecture
|
||||
- Development Workflow
|
||||
- Testing Strategy
|
||||
- Build & Release Process
|
||||
- Extensibility
|
||||
- Known Limitations
|
||||
- Maintenance & Updates
|
||||
|
||||
---
|
||||
|
||||
@@ -1480,14 +1480,14 @@ graph TB
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- **[README.md](README.md)** - Project overview and quick start
|
||||
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Contribution guidelines
|
||||
- **[docs/features.md](docs/features.md)** - Detailed feature documentation
|
||||
- **[docs/api.md](docs/api.md)** - REST API reference
|
||||
- **[docs/database-schema.md](docs/database-schema.md)** - Database structure
|
||||
- **[docs/cerberus.md](docs/cerberus.md)** - Security suite documentation
|
||||
- **[docs/getting-started.md](docs/getting-started.md)** - User guide
|
||||
- **[SECURITY.md](SECURITY.md)** - Security policy and vulnerability reporting
|
||||
- README.md - Project overview and quick start
|
||||
- CONTRIBUTING.md - Contribution guidelines
|
||||
- docs/features.md - Detailed feature documentation
|
||||
- docs/api.md - REST API reference
|
||||
- docs/database-schema.md - Database structure
|
||||
- docs/cerberus.md - Security suite documentation
|
||||
- docs/getting-started.md - User guide
|
||||
- SECURITY.md - Security policy and vulnerability reporting
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ Follow these guidelines for formatting and structuring your markdown content:
|
||||
- **Headings**: Use `##` for H2 and `###` for H3. Ensure that headings are used in a hierarchical manner. Recommend restructuring if content includes H4, and more strongly recommend for H5.
|
||||
- **Lists**: Use `-` for bullet points and `1.` for numbered lists. Indent nested lists with two spaces.
|
||||
- **Code Blocks**: Use triple backticks (`) to create fenced code blocks. Specify the language after the opening backticks for syntax highlighting (e.g., `csharp).
|
||||
- **Links**: Use `[link text](URL)` for links. Ensure that the link text is descriptive and the URL is valid.
|
||||
- **Links**: Use `[link text](https://example.com)` for links. Ensure that the link text is descriptive and the URL is valid.
|
||||
- **Images**: Use `` for images. Include a brief description of the image in the alt text.
|
||||
- **Tables**: Use `|` to create tables. Ensure that columns are properly aligned and headers are included.
|
||||
- **Line Length**: Break lines at 80 characters to improve readability. Use soft line breaks for long paragraphs.
|
||||
|
||||
Reference in New Issue
Block a user