Skip to content

fix: resolve markdown link errors in PR #543#551

Open
yibeichan wants to merge 3 commits intomainfrom
drawing
Open

fix: resolve markdown link errors in PR #543#551
yibeichan wants to merge 3 commits intomainfrom
drawing

Conversation

@yibeichan
Copy link
Contributor

This PR fixes the markdown link errors that were causing the markdown-link-check CI failure in PR #543.

Changes made:

  • Removed broken NLM CDE link (404 error)
  • Removed broken CEDAR Metadata Model link (unreachable)
  • Fixed image paths in multiple files
  • Added Properties of ReproSchema Objects section with anchor

Fixed files:

  • docs/introduction.md
  • docs/schema/schema.md
  • docs/tutorials/create-new-protocol.md

CI Status:

Before: markdown-link-check: FAILURE, pre-commit: FAILURE
After: markdown-link-check: PASS

Fixes #543

djarecka and others added 3 commits July 19, 2025 10:43
- Removed broken NLM CDE link
- Removed broken CEDAR Metadata Model link
- Fixed image path in docs/tutorials/create-new-protocol.md
- Fixed image path in docs/schema/schema.md
- Added Properties of ReproSchema Objects section

Resolves markdown-link-check failure in PR #543.
@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on improving the stability and clarity of the project's documentation. It addresses critical issues such as broken markdown links and incorrect image paths that were causing CI failures, ensuring the documentation is accurate and accessible. Additionally, it significantly enhances the schema documentation by providing detailed property descriptions and introduces new internal guidelines and a strategic proposal for a future documentation reorganization. A new backgroundImage slot was also added to the core schema, expanding its capabilities.

Highlights

  • Documentation Link Fixes: Resolved broken markdown links in documentation, specifically removing a broken NLM CDE link and a CEDAR Metadata Model link.
  • Image Path Corrections: Corrected relative image paths across multiple documentation files to ensure images render correctly.
  • Schema Documentation Enhancement: Expanded the docs/schema/schema.md file with a new, detailed section outlining the properties of various ReproSchema objects (Protocol, Activity, Field, ResponseOption, UI).
  • Schema Definition Update: Introduced a new backgroundImage slot in the core LinkML schema (linkml-schema/reproschema.yaml), enabling the specification of background images for drawing activities.
  • Internal Documentation Additions: Added new internal documentation files (internal/CLAUDE.md, internal/CLAUDE.md.bak, internal/DOCUMENTATION_REORGANIZATION_PROPOSAL.md) providing repository guidelines, development practices, and a proposal for a comprehensive documentation reorganization using the Diátaxis framework.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/introduction.md
    • Updated a broken NLM CDE link to a more general reference.
    • Removed a broken link and reference to the CEDAR Metadata Model.
  • docs/schema/schema.md
    • Fixed an image path from ../../img/reproschema.png to ../img/reproschema.png.
    • Added a new section titled 'Properties of ReproSchema Objects' detailing various schema properties.
    • Removed a redundant sentence about the CEDAR Metadata Model.
  • docs/tutorials/create-new-protocol.md
    • Fixed an image path from ../../img/phq-9_ui.png to ../img/phq-9_ui.png.
  • internal/CLAUDE.md
    • Added a new file outlining repository purpose, local overrides, tech stack, key commands, dependencies, current focus, recent changes, local patterns, and quick links.
  • internal/CLAUDE.md.bak
    • Added a new file detailing repository guidelines, development guidelines, testing instructions, commit format, internal notes, and a template for lessons learned.
  • internal/DOCUMENTATION_REORGANIZATION_PROPOSAL.md
    • Added a new file proposing a documentation reorganization using the Diátaxis framework, outlining the problem, solution, new structure, benefits, and migration plan.
  • linkml-schema/reproschema.yaml
    • Added a new backgroundImage slot with a description and range to the schema definition.
    • Included backgroundImage in the list of slots for relevant classes.
Activity
  • The markdown-link-check CI status changed from FAILURE to PASS.
  • The pre-commit CI status changed from FAILURE to PASS.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request aims to fix broken markdown links. While most of the changes correctly fix broken image paths and remove dead links, one of the link fixes in docs/introduction.md is incorrect and replaces a URL with invalid text. Additionally, this PR introduces a backup file (.bak) which should not be committed to version control. There are also a couple of minor style issues in the new markdown files related to missing newlines at the end of the file. I've added specific comments with suggestions for these points.

[Cognitive Paradigm Ontology](http://www.cogpo.org/)). Other efforts such as the
National Institute for Mental Health (NIMH) Data Archive (NDA) and the National
Library of Medicine (NLM) [Common Data Elements](https://www.nlm.nih.gov/cde/index.html)
Library of Medicine (NLM) [Common Data Elements](data standards initiatives)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The link for 'Common Data Elements' has been replaced with data standards initiatives, which is not a valid URL. The original link was likely marked as broken due to a redirect. The correct, updated link is available. Using the updated link is better than removing it or using an invalid one.

Suggested change
Library of Medicine (NLM) [Common Data Elements](data standards initiatives)
Library of Medicine (NLM) [Common Data Elements](https://www.nlm.nih.gov/oet/ed/cde/index.html)

- Terms: /terms/

---
*Line count: ~55 (target: < 100)* No newline at end of file

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This file does not end with a newline character. It is a common convention and good practice to end text files with a newline character. This prevents issues with some command-line tools (like cat) and version control systems. Please add a newline at the end of the file.

@@ -0,0 +1,42 @@
# ReproSchema Repository Guidelines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This file appears to be a backup file (.bak). Backup files should generally not be committed to the version control system as they add unnecessary clutter. Please remove this file from the pull request.

3. Begin content migration
4. Write new content to fill gaps

This reorganization will make ReproSchema documentation more accessible, reduce confusion, and provide clear paths for all user types. No newline at end of file

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This file does not end with a newline character. It is a common convention and good practice to end text files with a newline character. This prevents issues with some command-line tools (like cat) and version control systems. Please add a newline at the end of the file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants