Skip to content

Commit c97c4b6

Browse files
committed
v1.0.1: bump version and complete documentation hub structure
1 parent 01049b9 commit c97c4b6

18 files changed

Lines changed: 607 additions & 551 deletions
Lines changed: 12 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,18 @@
1-
# 🏷️ Citation Styles: APA 7, IEEE, & BibTeX
1+
# 📑 Citation Styles Guide (APA, IEEE, BibTeX)
22

3-
Accurate referencing is essential to maintain academic integrity and avoid plagiarism.
3+
Accurate referencing is essential for academic integrity.
44

5-
---
6-
7-
## 📌 1. APA 7th Edition
8-
9-
### In-Text Citation
10-
- Single Author: (Vaswani, 2017)
11-
- Two Authors: (Goodfellow & Bengio, 2016)
12-
- Three+ Authors: (Devlin et al., 2019)
13-
14-
### Reference List Entry
15-
> Vaswani, A., Shazeer, N., Parmar, N., Uszkoreit, J., Jones, L., Gomez, A. N., Kaiser, Ł., & Polosukhin, I. (2017). Attention is all you need. *Advances in Neural Information Processing Systems*, 30, 5998–6008.
16-
17-
---
18-
19-
## ⚡ 2. IEEE Style
20-
21-
### In-Text Citation
22-
Numeric citations inside square brackets:
23-
- As demonstrated in [1] and extended by [2]-[4]...
24-
25-
### Reference List Entry
26-
> [1] A. Vaswani et al., "Attention is all you need," in *Proc. Adv. Neural Inf. Process. Syst. (NIPS)*, 2017, pp. 5998–6008.
27-
28-
---
29-
30-
## 📄 3. BibTeX (LaTeX Format)
31-
32-
Store in your `.bib` file:
5+
## 📌 BibTeX Example
336

347
```bibtex
35-
@inproceedings{vaswani2017attention,
36-
title = {Attention is all you need},
37-
author = {Vaswani, Ashish and Shazeer, Noam and Parmar, Niki and Uszkoreit, Jakob and Jones, Llion and Gomez, Aidan N and Kaiser, {\L}ukasz and Polosukhin, Illia},
38-
booktitle = {Advances in Neural Information Processing Systems},
39-
volume = {30},
40-
pages = {5998--6008},
41-
year = {2017}
8+
@article{vaswani2017attention,
9+
title={Attention is all you need},
10+
author={Vaswani, Ashish and Shazeer, Noam and Parmar, Niki and Uszkoreit, Jakob and Jones, Llion and Gomez, Aidan N and Kaiser, {\L}ukasz and Polosukhin, Illia},
11+
journal={Advances in neural information processing systems},
12+
volume={30},
13+
year={2017}
4214
}
4315
```
16+
17+
## 📐 IEEE Style Example
18+
`[1] A. Vaswani et al., "Attention is all you need," Adv. Neural Inf. Process. Syst., vol. 30, 2017.`
Lines changed: 11 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,29 @@
1-
# 🪶 LaTeX Research Paper Template Masterclass
1+
# 📐 LaTeX Paper Writing Masterclass
22

3-
LaTeX provides unmatched precision for formatting equations, tables, figures, and bibliographies in conference papers and journal submissions.
4-
5-
---
6-
7-
## 📄 Complete IEEE / Overleaf Article Starter Template
8-
9-
Save this as `main.tex` in Overleaf or your local TeX distribution:
3+
LaTeX provides unmatched typesetting quality for scientific formulas and figures.
104

115
```latex
126
\documentclass[conference]{IEEEtran}
137
\usepackage{cite}
148
\usepackage{amsmath,amssymb,amsfonts}
15-
\usepackage{algorithmic}
169
\usepackage{graphicx}
17-
\usepackage{textcomp}
18-
\usepackage{xcolor}
19-
20-
\begin{document}
21-
22-
\title{Novel Deep Learning Approaches for Open Research Documentation}
2310
24-
\author{\IEEEauthorblockN{Sahadat Nisad}
25-
\IEEEauthorblockA{\textit{Research Help BD} \\
26-
Dhaka, Bangladesh \\
27-
contact@researchhelpbd.org}
28-
}
11+
\title{Your Research Paper Title}
12+
\author{\IEEEauthorblockN{Author Name}
13+
\IEEEauthorblockA{\textit{Department of Computer Science} \\
14+
\textit{University Name}\\
15+
City, Country \\
16+
email@domain.com}}
2917
18+
\begin{document}
3019
\maketitle
3120
3221
\begin{abstract}
33-
This paper presents a modern framework for publishing open-access research documentation using static site generators and markdown automation...
22+
Your abstract goes here...
3423
\end{abstract}
3524
36-
\begin{IEEEkeywords}
37-
Open Access, Documentation, LaTeX, Machine Learning, GitHub Pages
38-
\end{IEEEkeywords}
39-
4025
\section{Introduction}
41-
Recent developments in academic publishing require faster dissemination of research notes...
42-
43-
\section{Methodology}
44-
The loss function is defined as:
45-
\begin{equation}
46-
\mathcal{L} = \frac{1}{N}\sum_{i=1}^{N} (y_i - \hat{y}_i)^2
47-
\end{equation}
48-
49-
\section{Conclusion}
50-
Our open-access framework reduces publication latency to zero.
51-
52-
\bibliographystyle{IEEEtran}
53-
\bibliography{references}
26+
Introduction section content...
5427
5528
\end{document}
5629
```
Lines changed: 8 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,11 @@
1-
# 📚 Systematic Literature Review Guide
1+
# 📚 Literature Review Guide
22

3-
A literature review surveys books, scholarly articles, and any other sources relevant to a particular issue, area of research, or theory.
3+
A literature review synthesizes existing academic research to justify a new study or research proposal.
44

5-
---
5+
## 🔑 5 Steps to Write a Literature Review
66

7-
## 🎯 5 Key Steps to a Great Literature Review
8-
9-
### 1. Search for Relevant Literature
10-
Define key terms and boolean operators for database queries:
11-
```text
12-
("transformer models" OR "self-attention") AND ("computer vision" OR "image classification") AND NOT "survey"
13-
```
14-
15-
### 2. Evaluate & Select Sources
16-
Assess paper quality using:
17-
- Citation count & impact factor of journal
18-
- Clarity of methodology & dataset quality
19-
- Recency (last 3-5 years for fast-moving fields like AI)
20-
21-
### 3. Identify Themes, Debates, & Gaps
22-
Organize papers into thematic clusters rather than summarizing paper by paper.
23-
24-
```mermaid
25-
graph TD
26-
A[Literature Pool] --> B[Theme 1: Supervised Learning]
27-
A --> C[Theme 2: Self-Supervised Pretraining]
28-
A --> D[Theme 3: Domain Adaptation]
29-
B --> E[Research Gap Identified 💡]
30-
C --> E
31-
D --> E
32-
```
33-
34-
### 4. Outline Your Structure
35-
- **Chronological**: Tracing development over time.
36-
- **Thematic**: Grouping by sub-topic.
37-
- **Methodological**: Grouping by data collection techniques.
38-
39-
### 5. Write Your Review
40-
State the research gap clearly in the final paragraphs to justify your current study!
7+
1. **Search Relevant Literature**: Use Google Scholar, IEEE Xplore, PubMed, and arXiv.
8+
2. **Evaluate & Select Sources**: Filter by impact factor, peer-review status, and relevance.
9+
3. **Identify Themes & Gaps**: Spot contradictions, unanswered questions, or methodological flaws.
10+
4. **Outline Structure**: Organize chronologically, thematically, or methodologically.
11+
5. **Synthesize & Write**: Write critically rather than summarizing paper by paper.
Lines changed: 29 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,34 @@
1-
# 🤝 How to Contribute Docs & Research
1+
# 🤝 How to Contribute
22

3-
We welcome contributions from students, researchers, professors, and open-source enthusiasts worldwide! You can contribute research summaries, methodology guides, paper digests, or open datasets.
3+
We welcome contributions from researchers, students, educators, and software engineers worldwide!
44

5-
---
6-
7-
## 🛠️ Step-by-Step Contribution Workflow
8-
9-
### Step 1: Fork or Clone the Repository
10-
Clone your repository locally to make edits:
11-
```bash
12-
git clone https://github.com/sahadatnisad/reserachhelpbd.git
13-
cd reserachhelpbd
14-
```
15-
16-
### Step 2: Install Dependencies
17-
Ensure you have Node.js (v18+) installed, then run:
18-
```bash
19-
npm install
20-
```
5+
## 📌 Ways to Contribute
216

22-
### Step 3: Run the Local Preview Server
23-
Start the development server with live reload:
24-
```bash
25-
npm run docs:dev
26-
```
27-
Open `http://localhost:5173/reserachhelpbd/` in your browser to preview changes in real time.
7+
- **Add Paper Summaries**: Write digests for impactful research papers in your field.
8+
- **Improve Writing Guides**: Share tips on LaTeX, grant writing, or citation management.
9+
- **Submit Templates**: Share formatted LaTeX or Markdown templates for research proposals.
10+
- **Fix Errors**: Correct typos, update broken links, or improve mathematical formulas.
2811

29-
### Step 4: Add Your Markdown File
30-
Create a new `.md` file in the appropriate folder under `docs/`. For example:
31-
- Adding a paper digest on AI: `docs/research-papers/ai-machine-learning/my-new-paper.md`
32-
- Adding a writing guide: `docs/academic-writing/my-writing-guide.md`
33-
34-
### Step 5: Register the File in Sidebar Navigation
35-
Open `docs/.vitepress/config.mjs` and add your file link to the `sidebar` array so it shows up in the left navigation menu!
36-
37-
```javascript
38-
{ text: 'My New Paper Title', link: '/research-papers/ai-machine-learning/my-new-paper' }
39-
```
12+
---
4013

41-
### Step 6: Commit and Push
42-
```bash
43-
git add .
44-
git commit -m "feat: add research digest on My New Paper"
45-
git push origin main
46-
```
47-
The automated GitHub Actions workflow will automatically build and publish your update live worldwide! 🚀
14+
## 🛠️ Contribution Workflow
15+
16+
1. **Fork the Repository**: Visit [GitHub Repository](https://github.com/sahadatnisad/reserachhelpbd) and click **Fork**.
17+
2. **Clone your fork**:
18+
```bash
19+
git clone https://github.com/YOUR_USERNAME/reserachhelpbd.git
20+
cd reserachhelpbd
21+
```
22+
3. **Create a new branch**:
23+
```bash
24+
git checkout -b docs/add-my-paper-digest
25+
```
26+
4. **Add your Markdown file**: Add your `.md` file under the appropriate folder inside `docs/`.
27+
5. **Update `.vitepress/config.mjs`**: Add your page link to the sidebar.
28+
6. **Commit & Push**:
29+
```bash
30+
git add .
31+
git commit -m "docs: add paper digest on transformer models"
32+
git push origin docs/add-my-paper-digest
33+
```
34+
7. **Open a Pull Request**: Create a PR on the main repository.
Lines changed: 11 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,22 @@
11
# 🚀 Introduction to Research Help BD
22

3-
Welcome to **Research Help BD** — a global open-access research repository and documentation hub designed to organize, publish, and share academic research, study digests, methodology guides, and educational tools in a clean, docs-style format.
4-
5-
<span class="badge-tag">Open Access</span> <span class="badge-tag">Documentation</span> <span class="badge-tag">Worldwide</span>
6-
7-
---
3+
Welcome to **Research Help BD**, a global open-access documentation repository and academic research hub.
84

95
## 🎯 Our Mission
106

11-
Academic research should be **accessible, well-organized, and easily readable** for everyone across the globe. Traditional research PDFs can often be difficult to search or read on mobile devices. **Research Help BD** converts academic knowledge into a modern web documentation format featuring:
12-
13-
- **Instant Full-Text Search**: Search topics, equations, code snippets, or citation keys in seconds.
14-
- **TeX Math & Equation Rendering**: Native support for mathematical formulations using LaTeX syntax.
15-
- **Structured Categories**: Browse papers by field (AI/ML, Data Science, Biotechnology, Social Sciences).
16-
- **Responsive & Dark-Mode Friendly**: Clean reading experience across mobile phones, tablets, and desktops.
17-
- **Zero Cost & Free Hosting**: Powered by GitHub Pages for worldwide reliability and open collaboration.
18-
19-
---
20-
21-
## 🗺️ How Content is Organized
22-
23-
The documentation structure is designed to be intuitive and scalable:
7+
Research Help BD aims to bridge the gap between academic research, technical documentation, and open knowledge sharing. We provide researchers, students, and academics worldwide with:
248

25-
```
26-
docs/
27-
├── getting-started/ # Overview, rules, and contribution guides
28-
├── research-papers/ # Papers, research summaries, and technical digests
29-
│ ├── ai-machine-learning/
30-
│ ├── data-science/
31-
│ └── biotechnology/
32-
├── academic-writing/ # Writing methodology, literature review tips, LaTeX & citations
33-
├── research-tools/ # Software guides (Zotero, Mendeley, arXiv, open datasets)
34-
└── templates/ # Copy-paste research proposal & summary templates
35-
```
9+
1. **Structured Research Digests**: Summaries of breakthrough papers in AI, Data Science, Biotechnology, and domain sciences.
10+
2. **Academic Writing Guides**: Complete tutorials on writing literature reviews, LaTeX formatting, and citation standards (APA, IEEE, BibTeX).
11+
3. **Essential Research Tools**: Guides for Zotero, Mendeley, arXiv, and open data repositories.
12+
4. **Ready-to-Use Templates**: Reusable templates for research proposals, study notes, and paper summaries.
3613

3714
---
3815

39-
## 🌍 Sharing Worldwide
40-
41-
Every page on this site has a permanent, clean URL. Anyone with an internet connection can access your research documentation.
42-
43-
- **Primary Repository**: [github.com/sahadatnisad/reserachhelpbd](https://github.com/sahadatnisad/reserachhelpbd)
44-
- **Live Documentation Website**: [sahadatnisad.github.io/reserachhelpbd/](https://sahadatnisad.github.io/reserachhelpbd/)
45-
46-
---
16+
## 🌐 Open Access Principles
4717

48-
## 🤝 Next Steps
18+
All content hosted on Research Help BD is published under the **MIT License** and is fully open-access.
4919

50-
- Learn [How to Contribute](/getting-started/how-to-contribute) new papers or notes.
51-
- Read the [Publishing Guide](/getting-started/publishing-guide) to format markdown and equations.
52-
- Explore sample [Research Papers](/research-papers/).
20+
- **No Paywalls**: Knowledge should be free and accessible to everyone.
21+
- **Collaborative**: Open for contributions from researchers across Bangladesh and globally.
22+
- **Version Controlled**: Powered by Git and Markdown for clear history and easy updates.
Lines changed: 14 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,27 @@
1-
# ✍️ Research Publishing & Formatting Guide
1+
# 📖 Publishing Guidelines
22

3-
This guide covers how to format your research documents with LaTeX equations, code blocks, callouts, diagrams, and citations.
3+
To maintain academic quality and readability across **Research Help BD**, please follow these guidelines when writing documentation.
44

5-
---
6-
7-
## 🧮 1. Mathematical Formulas (LaTeX)
8-
9-
You can write LaTeX math equations directly inline or in block mode.
5+
## 📝 Markdown & Formatting Standards
106

11-
### Inline Math
12-
Use single dollar signs `$ ... $`:
13-
- Example: `$E = mc^2$` renders as $E = mc^2$.
14-
- Example: `$\sigma(z) = \frac{1}{1 + e^{-z}}$` renders as $\sigma(z) = \frac{1}{1 + e^{-z}}$.
15-
16-
### Display / Block Math
17-
Use double dollar signs `$$ ... $$`:
18-
19-
$$
20-
\mathcal{L}(\theta) = -\frac{1}{N} \sum_{i=1}^{N} \left[ y_i \log(\hat{y}_i) + (1 - y_i) \log(1 - \hat{y}_i) \right]
21-
$$
22-
23-
```latex
24-
$$
25-
\mathcal{L}(\theta) = -\frac{1}{N} \sum_{i=1}^{N} \left[ y_i \log(\hat{y}_i) + (1 - y_i) \log(1 - \hat{y}_i) \right]
26-
$$
27-
```
7+
- **Use Clear Headings**: Organize your document with `#`, `##`, and `###` hierarchy.
8+
- **LaTeX Math Rendering**:
9+
- Inline math: `$E = mc^2$`
10+
- Block math:
11+
$$\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$$
12+
- **Code Blocks**: Always specify the language tag for syntax highlighting (e.g. ````python`, ````latex`, ````bibtex`).
13+
- **Attribution & References**: Always cite original paper authors, DOI, and publication venue.
2814

2915
---
3016

31-
## 💡 2. Custom Callout Containers
32-
33-
Use containers to highlight key insights, warnings, or notes:
34-
35-
::: tip 💡 Research Tip
36-
Always store raw dataset backups before running transformation scripts.
37-
:::
38-
39-
::: info ℹ️ Note
40-
This paper was originally presented at NeurIPS 2025.
41-
:::
42-
43-
::: warning ⚠️ Important Assumption
44-
Model performance degrades if batch normalization parameters are uncalibrated.
45-
:::
46-
47-
---
48-
49-
## 📊 3. Code Blocks & Pseudocode
50-
51-
Use fenced code blocks with language syntax highlighting:
17+
## 🎯 Code & Formula Style Guide
5218

5319
```python
54-
import numpy as np
55-
56-
def compute_attention(Q, K, V):
57-
"""Compute Scaled Dot-Product Attention."""
20+
def calculate_attention(Q, K, V):
21+
"""Computes Scaled Dot-Product Attention."""
22+
import numpy as np
5823
d_k = Q.shape[-1]
5924
scores = np.matmul(Q, K.T) / np.sqrt(d_k)
6025
weights = np.exp(scores) / np.sum(np.exp(scores), axis=-1, keepdims=True)
6126
return np.matmul(weights, V)
6227
```
63-
64-
---
65-
66-
## 📚 4. Academic Citation References
67-
68-
Use clean markdown blockquotes or bibtex references for citing papers:
69-
70-
> **Citation**: Vaswani, A., et al. (2017). "Attention Is All You Need." *Advances in Neural Information Processing Systems*, 30. [DOI: 10.48550/arXiv.1706.03762](https://arxiv.org/abs/1706.03762)

0 commit comments

Comments
 (0)