Skip to content

kvncrtr/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Here’s how you can use a Markdown documentation repo effectively:


1. Create a Documentation-Focused Repository

  • Purpose: The repository can be a collection of your notes, learnings, tutorials, or technical documentation.

  • Structure: Organize the repository with folders and files:

    /docs
        ├── README.md
        ├── daily-log
        │     ├── 2024-06-01.md
        │     ├── 2024-06-02.md
        │     └── ...
        ├── tutorials
        │     ├── git-guide.md
        │     ├── python-basics.md
        └── tools.md
    
  • You can use this as a "learning journal" or knowledge base.


2. Ideas for Daily Updates

Here are ways to generate meaningful daily contributions:

Start of Day

  • Daily Logs: Plan for the work ahead of you.
  • Daily Standup: Adopt the agile methodology to focus on delivering value through incremental progress.

End of Day

  • Daily Bread: Write about what you learned.
  • Technical Summaries: Summarize topics like "Git basics," "HTTP protocols," or "Python dictionaries."
  • Project Notes: Document work on other coding projects, such as architecture, troubleshooting, or improvements.
  • Code Snippets: Add small scripts or commands (in Markdown's code blocks) with explanations.
  • Tools and Tips: Share notes on tools like VS Code, Docker, or Git.
  • Tutorial Progress: If you're learning something new (like React or Kubernetes), document each step or section.

3. Automate Updates

If you want consistency, automate some parts:

  • Pre-schedule commits: Use a script to push pre-written updates for upcoming days.
  • GitHub Actions: Automate a script that generates a "daily update" log or even pulls in external stats (like coding time or weather).
  • Dynamic Content: Write scripts that append timestamps, daily reflections, or progress summaries to Markdown files.

4. Tools to Help You Write Markdown

  • Markdown Editors: Use tools like Obsidian, Typora, or VS Code with Markdown plugins.
  • Markdown Templates: Create reusable templates for daily logs, project notes, or summaries.

Example daily log template:

# Daily Log - YYYY-MM-DD

## What I Learned Today
- Topic 1:
- Topic 2:

## Challenges Faced
- Issue 1:
- Solution/Attempt:

## Notes
- Useful resources:

5. Benefits of This Approach

  • Ethical and Transparent: You’re producing real, meaningful work.
  • Skill Improvement: Writing documentation improves your technical understanding and communication skills.
  • Portfolio Building: Over time, this repository becomes a valuable showcase of your progress and knowledge.
  • Daily Contributions: Updates count as commits on GitHub and help maintain your activity streak.

6. Make It Look Professional

  • Add a well-written README.md to explain the purpose of your repository.
  • Organize content neatly with headings, tables, and links.
  • Add visuals like diagrams, screenshots, or badges to make it visually appealing.

Example Workflow

  1. Create or update a Markdown file every day.
  2. Commit and push:
    git add .
    git commit -m "Update daily log for YYYY-MM-DD"
    git push
  3. Over time, this becomes a valuable, well-documented knowledge hub.

1. Contribute Regularly

  • Work on Small Improvements: Break your work into smaller, manageable tasks. Commit incremental updates, such as fixing typos in documentation, refactoring code, or improving test cases.
  • Personal Projects: Maintain side projects and update them regularly. Even small changes count as contributions.
  • Open Source Contributions: Engage with open-source projects. Fix bugs, update documentation, or participate in discussions.
  • Learning Logs: Commit code from tutorials or learning exercises as you study new topics or tools.

2. Schedule Commits

  • Pre-Schedule Commits: If your actual workflow doesn't involve daily commits, you can write a week's worth of changes in one go and schedule the commits using Git's --date option:
    git commit --date="YYYY-MM-DD HH:MM:SS" -m "Scheduled commit"
  • Automation Tools: Use tools like GitHub Actions to automate updates, such as generating daily reports or updating stats.

3. Work on Diverse Repositories

  • Spread your work across multiple repositories to ensure variety in your contributions.
  • Fork and experiment with repositories, and then merge updates.

4. Contribute Beyond Code

  • Contributions like opening issues, reviewing pull requests, and editing wikis also count as activity.
  • Update README files, add examples, or create templates for projects.

5. Ethical Considerations

  • It's important to avoid fake contributions. Genuine activity is better for long-term skill development and credibility.
  • If you're using scheduling or automation, ensure the contributions reflect meaningful work, even if spread out for appearance.

Headers

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Header 1

Header 2

Header 3


Text Formatting

*Italic* or _Italic_  
**Bold** or __Bold__  
***Bold and Italic***  
~~Strikethrough~~  

Italic
Bold
Bold and Italic
Strikethrough


Lists

Unordered List:

- Item 1
- Item 2
  - Subitem 2.1
  - Subitem 2.2
* Item 3
  • Item 1
  • Item 2
    • Subitem 2.1
    • Subitem 2.2
  • Item 3

Ordered List:

1. Item 1
2. Item 2
   1. Subitem 2.1
   2. Subitem 2.2
3. Item 3
  1. Item 1
  2. Item 2
    1. Subitem 2.1
    2. Subitem 2.2
  3. Item 3

Links and Images

Link:

[Link Text](https://example.com)

Link Text

Image:

![Alt Text](https://example.com/image.jpg)

Alt Text


Blockquotes

> This is a blockquote.
>> Nested blockquote.

This is a blockquote.

Nested blockquote.


Code

Inline Code:

`inline code`

inline code

Code Block:

```language
Code here
```

Example:

print("Hello, World!")

Horizontal Rule

---
***
___


Tables

| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Data 1   | Data 2   | Data 3   |
| Data 4   | Data 5   | Data 6   |
Column 1 Column 2 Column 3
Data 1 Data 2 Data 3
Data 4 Data 5 Data 6

Tasks

- [ ] Task 1
- [x] Task 2 (completed)
  • Task 1
  • Task 2 (completed)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published