Skip to content

Commit 2b4978b

Browse files
committed
docs: update README with R&D page information
- Add research pages to project structure - Document research-documents directory - Add markdown-renderer component to structure - Include research utilities in lib section - Add guidelines for creating new research papers
1 parent eda9d52 commit 2b4978b

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,21 @@ tiverse-website/
3434
│ ├── blog/ # Blog listing
3535
│ ├── contact/ # Contact form
3636
│ ├── projects/ # Projects showcase
37+
│ ├── research/ # R&D research papers
38+
│ │ ├── [slug]/ # Individual research document
39+
│ │ └── page.tsx # Research listing
3740
│ ├── layout.tsx # Root layout
3841
│ ├── page.tsx # Homepage
3942
│ └── not-found.tsx # 404 page
4043
├── components/
4144
│ ├── ui/ # Shadcn/UI components
4245
│ ├── layout/ # Layout components (header, footer)
46+
│ ├── markdown-renderer.tsx # Markdown renderer with TOC
4347
│ └── theme-provider.tsx # Theme provider
4448
├── lib/
49+
│ ├── research.ts # Research document utilities
4550
│ └── utils.ts # Utility functions
51+
├── research-documents/ # Markdown research papers
4652
├── public/ # Static assets
4753
└── styles/
4854
└── globals.css # Global styles
@@ -150,6 +156,35 @@ Add a new project to the `projects` array in `app/projects/page.tsx`:
150156
}
151157
```
152158

159+
### New Research Paper
160+
161+
Add a new markdown file to the `research-documents/` directory:
162+
163+
```markdown
164+
---
165+
title: "Your Research Title"
166+
authors:
167+
- "Author Name"
168+
date: "2024-01-20"
169+
abstract: "Brief abstract..."
170+
category: "AI/ML"
171+
tags: ["machine-learning", "research"]
172+
featured: true
173+
status: "published"
174+
---
175+
176+
# Your Research Content
177+
178+
Write your research paper in markdown format with full support for:
179+
- Code syntax highlighting
180+
- Mathematical equations (LaTeX)
181+
- Tables and diagrams
182+
- Automatic table of contents
183+
- Citations and references
184+
```
185+
186+
See `research-documents/README.md` for detailed documentation on writing research papers.
187+
153188
## 🚀 Deployment
154189

155190
### Vercel (Recommended)

0 commit comments

Comments
 (0)