Skip to content

CUSTOMIZATION_GUIDE.md

Latest commit

 

History

History
250 lines (171 loc) · 6.78 KB

CUSTOMIZATION_GUIDE.md

File metadata and controls

250 lines (171 loc) · 6.78 KB
Raw

📝 Customization Guide

This guide helps you replace all placeholder content in the research template with your actual research information. Estimated time: 20-30 minutes.

Quick Start Checklist

Follow this checklist to ensure you've customized all placeholder content:

  • Research paper metadata (_quarto.yml)
  • Paper abstract and overview (index.qmd)
  • Introduction content (chapters/introduction.qmd)
  • Bibliography references (references.bib)
  • Slidev presentation metadata (slides.md)
  • Blog post author information (blog_posts/*.md)
  • Verify no placeholders remain

📄 Research Paper Placeholders

1. Paper Metadata (research_paper/_quarto.yml)

Location: Lines 5-10

Replace these fields with your information:

title: "Research Paper Title"           # Replace with your paper title
subtitle: "Paper Subtitle"              # Replace with your subtitle
author:
  - name: Your Name                     # Replace with your full name
    affiliation: Your Institution       # Replace with your university/org
    email: your.email@example.com       # Replace with your email

Example:

title: "Neural Network Optimization Using Gradient Descent"
subtitle: "A Comparative Analysis of Adaptive Learning Rates"
author:
  - name: Jane Smith
    affiliation: MIT Computer Science Department
    email: jsmith@mit.edu

2. Paper Abstract (research_paper/index.qmd)

Location: Abstract section (callout-important block)

Replace the placeholder callout with your 150-250 word abstract:

::: {.callout-important}
## Abstract

Write your 150-250 word abstract here. Include:
- Research problem and motivation
- Methodology overview
- Key findings
- Implications
:::

Example:

::: {.callout-important}
## Abstract

This paper investigates the effectiveness of adaptive learning rate algorithms in deep neural network training. We compare three popular optimizers—Adam, RMSprop, and AdaGrad—across multiple benchmark datasets. Our experiments demonstrate that adaptive methods converge 40% faster than standard SGD while maintaining comparable accuracy. These findings have significant implications for training large-scale models efficiently.
:::

3. Research Overview (research_paper/index.qmd)

Location: Research Overview section (callout-important block)

Replace the placeholder callout with your research overview:

::: {.callout-important}
## Research Overview

Provide a high-level overview of your research:
- Research questions
- Scope and boundaries
- Expected contributions
:::

4. Introduction Content (research_paper/chapters/introduction.qmd)

Location: Multiple sections throughout the file

Replace all "lorem ipsum" placeholder text with your actual introduction content:

  • Background section: Replace with relevant context and prior work
  • Problem statement: Replace with your research problem
  • Contributions (4 items): Replace with your specific contributions

Example contributions:

1. **Novel Algorithm**: We introduce XYZ algorithm that improves performance by 25%
2. **Comprehensive Evaluation**: Benchmarking across 10 datasets with statistical analysis
3. **Open Source Implementation**: Publicly available code for reproducibility
4. **Practical Guidelines**: Best practices for practitioners in the field

5. Bibliography (research_paper/references.bib)

Location: Entire file (currently has 4 example references)

Replace example references with your actual citations:

@article{example2023,
  title={Your Paper Title},
  author={Author Name},
  journal={Journal Name},
  year={2023}
}

Resources for bibliography management:

  • Export from Google Scholar (BibTeX format)
  • Use Zotero or Mendeley for reference management
  • Ensure all in-text citations have corresponding entries

🎭 Slidev Presentation Placeholders

6. Presentation Metadata (slidev/slides.md)

Location: Lines 6 and 11

Replace these fields in the frontmatter:

info: |
  ## Lorem Ipsum by Dolor sit amet    # Line 6 - Replace with your info

title: The Lorem Ipsum Dolor sit amet  # Line 11 - Replace with your title

Example:

info: |
  ## Neural Network Optimization
  Research presentation by Jane Smith, MIT

title: Neural Network Optimization Using Adaptive Learning Rates

7. Package Description (slidev/package.json)

Location: Line 4

Note: This will be automatically fixed in the next phase. The current placeholder "lorem ipsum" will be replaced with: "Slidev presentation template for research papers and academic talks"

📱 Blog Post Placeholders

8. Blog Post Metadata (blog_posts/BLOG-POST1.md, BLOG-POST2.md, BLOG-POST3.md)

Location: Frontmatter in each file

Replace these fields in all three blog post files:

---
author: Your Name              # Replace with your name
date: YYYY-MM-DD              # Replace with actual publication date
---

Example:

---
author: Jane Smith
date: 2024-03-15
---

✅ Verification Instructions

After completing all replacements, verify no placeholders remain:

Quick Verification Commands

# Check for remaining lorem ipsum text
grep -r "lorem ipsum" research_paper/ slidev/ blog_posts/ || echo "✓ No lorem ipsum found"

# Check for generic placeholders
grep -r "Your Name" research_paper/ blog_posts/ || echo "✓ No 'Your Name' placeholders"
grep -r "Your Institution" research_paper/ || echo "✓ No 'Your Institution' placeholders"
grep -r "your.email@example.com" research_paper/ || echo "✓ No placeholder emails"

# Check for example references
grep -r "example2023" research_paper/ || echo "✓ No example references"

Manual Checklist

  • Preview paper: cd research_paper && quarto preview
  • Preview slides: cd slidev && npm run dev
  • Read through all blog posts for completeness
  • Verify author information is consistent across all files
  • Ensure all citations in text match references.bib entries

🎯 Summary

Total files to customize: 8-10 files

Component Files Est. Time
Research paper metadata 1 file 2 min
Paper content 2 files 10-15 min
Bibliography 1 file 5 min
Slidev slides 1 file 2 min
Blog posts 3 files 3 min
Verification - 3 min

Total estimated time: 25-30 minutes

💡 Pro Tip: Start with the metadata files (_quarto.yml, slides.md, blog_posts) first, then focus on content (introduction, abstract, references). This ensures consistent author information across all components.

🚀 Next Steps: After customization, see the main README.md for instructions on building and publishing your research.