Skip to content

[DOCS]: CONTRIBUTING.md link for file header management is brokenΒ #2817

@ja8zyjits

Description

@ja8zyjits

πŸ“š Documentation Issue Summary

The link at the bottom of CONTRIBUTING.md linking to File Header Management section is broken.
It redirects to https://github.com/IBM/mcp-context-forge/blob/docs/docs/development/module-documentation.md


πŸ“ Location of the Problem

https://github.com/IBM/mcp-context-forge/blob/main/CONTRIBUTING.md


✏️ Type of Issue

  • Typo or formatting issue
  • Outdated or incorrect information

πŸ’‘ Suggested Fix or Clarification (optional)

To link https://github.com/IBM/mcp-context-forge/blob/main/docs/docs/development/module-documentation.md we need to edit the CONTRIBUTING.md by replacing

./docs/docs/development/module-documentation.md

use instead

docs/docs/development/module-documentation.md


🧠 Environment (optional)

This file CONTRIBUTING.md is not part of the docs folder and hence we cannot test it via mkdocs serve command.
But we can test via the local browser rendering.


🧩 Screenshot

Image

Leads to

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    SHOULDP2: Important but not vital; high-value items that are not crucial for the immediate releasedocumentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions