docs: update info

Author: NoraNotDora

README.md

@@ -30,7 +30,8 @@ theme:
     - content.code.copy
     - search.suggest
     - search.highlight
-    - toc.integrate
+    - toc.follow
+    - navigation.indexes
   icon:
     repo: fontawesome/brands/github
 
@@ -46,6 +47,11 @@ validation:
   absolute_links: warn
   unrecognized_links: ignore
 
+# Exclude files from site build
+exclude_docs: |
+  images/README.md
+  **/README.md
+
 plugins:
   - search
 
@@ -55,6 +61,8 @@ markdown_extensions:
   - md_in_html
   - toc:
       permalink: true
+      toc_depth: 4
+      title: On this page
   - pymdownx.details
   - pymdownx.superfences
   - pymdownx.extra

docs/images/README.md

@@ -306,30 +306,35 @@ def generate_papers_section() -> str:
 
 
 def generate_tables_section() -> str:
-    """Generate the tables section from converted markdown files."""
-    tables_dir = ROOT / "docs" / "tables"
+    """Generate the tables section from tables.md file."""
+    tables_md = ROOT / "docs" / "tables.md"
 
-    if not tables_dir.exists():
-        print("[WARN] Tables directory not found, skipping tables section")
+    if not tables_md.exists():
+        print("[WARN] tables.md not found, skipping tables section")
         return "\n\nNo tables available yet.\n"
 
-    content = ["\n## 📋 Statistical Tables\n"]
-    content.append("Comprehensive tables and statistics about issue resolution datasets, methods, and benchmarks.\n")
-    
-    # Read all individual table files
-    table_files = sorted(tables_dir.glob("table*.md"))
-    
-    for table_file in table_files:
-        try:
-            table_content = table_file.read_text(encoding="utf-8")
-            content.append(f"\n{table_content}\n")
-        except Exception as e:
-            print(f"[WARN] Failed to read {table_file}: {e}")
-    
-    if len(content) == 2:  # Only header added
-        content.append("\nNo tables available yet.\n")
+    try:
+        content_text = tables_md.read_text(encoding="utf-8")
+        
+        # Extract content after the first "---" separator
+        # Skip the page title and intro text
+        lines = content_text.split('\n')
+        start_idx = 0
+        for i, line in enumerate(lines):
+            if line.strip() == '---' and i > 0:
+                start_idx = i + 1
+                break
+        
+        if start_idx > 0:
+            # Get the tables content
+            table_content = '\n'.join(lines[start_idx:])
+            return f"\n## 📋 Statistical Tables\n\nComprehensive tables and statistics about issue resolution datasets, methods, and benchmarks.\n\n{table_content}\n"
+        else:
+            return "\n\nNo tables available yet.\n"
 
-    return "\n".join(content)
+    except Exception as e:
+        print(f"[WARN] Failed to read tables.md: {e}")
+        return "\n\nNo tables available yet.\n"
 
 
 def generate_usage_section() -> str:

mkdocs.yml

@@ -375,9 +375,7 @@
 
 
 
-  
-
-<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
+<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
     <a href="/Awesome-Issue-Resolution/." title="Awesome Issue Resolution" class="md-nav__button md-logo" aria-label="Awesome Issue Resolution" data-md-component="logo">
 
@@ -544,6 +542,24 @@
               </div>
 
 
+              
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+                    
+
+  
+
+<nav class="md-nav md-nav--secondary" aria-label="On this page">
+  
+  
+  
+  
+</nav>
+                  </div>
+                </div>
+              </div>
+            
 
 
             <div class="md-content" data-md-component="content">
@@ -594,7 +610,7 @@ <h1>404 - Not found</h1>
 
 
 
-      <script id="__config" type="application/json">{"annotate": null, "base": "/Awesome-Issue-Resolution/", "features": ["navigation.instant", "navigation.tracking", "navigation.top", "navigation.tabs", "navigation.tabs.sticky", "content.code.copy", "search.suggest", "search.highlight", "toc.integrate"], "search": "/Awesome-Issue-Resolution/assets/javascripts/workers/search.7a47a382.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"annotate": null, "base": "/Awesome-Issue-Resolution/", "features": ["navigation.instant", "navigation.tracking", "navigation.top", "navigation.tabs", "navigation.tabs.sticky", "content.code.copy", "search.suggest", "search.highlight", "toc.follow", "navigation.indexes"], "search": "/Awesome-Issue-Resolution/assets/javascripts/workers/search.7a47a382.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
 
 
       <script src="/Awesome-Issue-Resolution/assets/javascripts/bundle.e71a0d61.min.js"></script>

scripts/sync_readme.py

@@ -388,9 +388,7 @@
 
 
 
-  
-
-<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
+<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
     <a href=".." title="Awesome Issue Resolution" class="md-nav__button md-logo" aria-label="Awesome Issue Resolution" data-md-component="logo">
 
@@ -549,7 +547,9 @@
 
 
 
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+  
+
+<nav class="md-nav md-nav--secondary" aria-label="On this page">
 
 
 
@@ -558,7 +558,7 @@
 
     <label class="md-nav__title" for="__toc">
       <span class="md-nav__icon md-icon"></span>
-      Table of contents
+      On this page
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
@@ -670,6 +670,100 @@
               </div>
 
 
+              
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+                    
+
+  
+
+<nav class="md-nav md-nav--secondary" aria-label="On this page">
+  
+  
+  
+    
+  
+  
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      On this page
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#about-this-project" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        About This Project
+      
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#key-features" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Key Features
+      
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#contribution-guide" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Contribution Guide
+      
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#acknowledgements" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Acknowledgements
+      
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#interactive-exploration" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Interactive Exploration
+      
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#contact-us" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Contact Us
+      
+    </span>
+  </a>
+  
+</li>
+      
+    </ul>
+  
+</nav>
+                  </div>
+                </div>
+              </div>
+            
 
 
             <div class="md-content" data-md-component="content">
@@ -784,7 +878,7 @@ <h2 id="contact-us">Contact Us<a class="headerlink" href="#contact-us" title="Pe
 
 
 
-      <script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.instant", "navigation.tracking", "navigation.top", "navigation.tabs", "navigation.tabs.sticky", "content.code.copy", "search.suggest", "search.highlight", "toc.integrate"], "search": "../assets/javascripts/workers/search.7a47a382.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.instant", "navigation.tracking", "navigation.top", "navigation.tabs", "navigation.tabs.sticky", "content.code.copy", "search.suggest", "search.highlight", "toc.follow", "navigation.indexes"], "search": "../assets/javascripts/workers/search.7a47a382.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
 
 
       <script src="../assets/javascripts/bundle.e71a0d61.min.js"></script>