Skip to content

Add table of contents and citations to README#10

Merged
rasikasrimal merged 2 commits into
mainfrom
copilot/update-readme-with-table-of-contents
Oct 14, 2025
Merged

Add table of contents and citations to README#10
rasikasrimal merged 2 commits into
mainfrom
copilot/update-readme-with-table-of-contents

Conversation

Copilot AI commented Oct 14, 2025

Copy link
Copy Markdown
Contributor

Overview

This PR enhances the README.md file to improve usability and credibility by adding a structured table of contents and comprehensive citations for all external tools, libraries, and research materials.

Changes

Table of Contents

Added a navigable table of contents at the beginning of the README that includes:

  • Links to all major sections (Screenshots, Key Capabilities, Getting Started, Testing and Quality, Data Roadmap, Responsible Use, Citations and References)
  • Nested subsections for Getting Started (Backend CLI, Frontend Dashboard, Frontend Experience Highlights)
  • Properly formatted anchor links that work seamlessly with GitHub's markdown rendering

Citations and References Section

Added a comprehensive new section documenting:

Backend Technologies with proper citations:

  • Core Python libraries (Python ≥3.10, Typer, Rich, NumPy, pandas)
  • Machine learning libraries (scikit-learn with academic citation, SHAP with NeurIPS 2017 citation)
  • Code analysis tools (tree-sitter, Radon)

Frontend Technologies:

  • React, Vite, TypeScript, and Tailwind CSS with links to official documentation

Related Research:

  • Academic citations for key papers on code authorship attribution and stylometry
  • References to foundational work by Burrows, Caliskan, and Solaiman

Citation Format:

  • BibTeX citation block for researchers to reference this project
  • Link to the existing CITATION.cff file for complete metadata

Enhanced Screenshots Section

  • Added descriptive introductory text explaining the web interface functionality
  • Improved alt text for all three images with meaningful descriptions instead of generic labels

Benefits

  • Improved Navigation: Users can quickly jump to relevant sections using the TOC
  • Enhanced Credibility: Proper citations demonstrate academic rigor and acknowledge dependencies
  • Better Accessibility: Descriptive alt text improves experience for users with screen readers
  • Professional Standards: Aligns with best practices for open-source project documentation

All changes maintain the existing content structure and formatting while adding these enhancements in a minimal, surgical manner.

Original prompt

The current README file for the Code Origin Detector lacks a table of contents and citations to enhance its usability and credibility. To improve the project's documentation and make it more professional, we need to update the README file with the following changes:

  1. Add a structured Table of Contents at the beginning of the README to help users navigate the document easily.
  2. Include citations or references for any external tools, libraries, or research materials mentioned.
  3. Ensure that any images, examples, or sections referenced are properly linked and described.
  4. Maintain a clean and professional formatting style that aligns with standard open-source project documentation practices.

This pull request was created as a result of the following prompt from Copilot chat.

The current README file for the Code Origin Detector lacks a table of contents and citations to enhance its usability and credibility. To improve the project's documentation and make it more professional, we need to update the README file with the following changes:

  1. Add a structured Table of Contents at the beginning of the README to help users navigate the document easily.
  2. Include citations or references for any external tools, libraries, or research materials mentioned.
  3. Ensure that any images, examples, or sections referenced are properly linked and described.
  4. Maintain a clean and professional formatting style that aligns with standard open-source project documentation practices.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@rasikasrimal rasikasrimal requested a review from Copilot October 14, 2025 21:23

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Co-authored-by: rasikasrimal <77890327+rasikasrimal@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to include table of contents and citations Add table of contents and citations to README Oct 14, 2025
Copilot AI requested a review from rasikasrimal October 14, 2025 21:27
@rasikasrimal rasikasrimal marked this pull request as ready for review October 14, 2025 21:32
@rasikasrimal rasikasrimal merged commit 00d7db0 into main Oct 14, 2025
0 of 4 checks passed
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.

3 participants