Skip to content

Commit

Permalink
docs: Add template for the internship projects ideas (#75)
Browse files Browse the repository at this point in the history
  • Loading branch information
xmnlab authored Dec 1, 2023
1 parent 26991e0 commit f996fe8
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 0 deletions.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ nav:
- Interns Guide: 'programs/internship/guides/interns/index.md'
- Mentors Guide: 'programs/internship/guides/mentors/index.md'
- "Cycle 2023-01": 'programs/internship/cycles/2023-01.md'
- Projects Ideas Template: 'programs/internship/templates/projects-ideas.md'
- Mentoring: 'programs/mentoring/index.md'
- Packaging Support: 'programs/packaging-support/index.md'
- Partners: 'programs/partners/index.md'
Expand Down
55 changes: 55 additions & 0 deletions pages/programs/internship/templates/projects-ideas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
```
Instructions:
* Remove HTML Comments: Please delete all content found within HTML
comment tags, denoted by <!-- and --> (in the source code of this file).
* Replace Placeholders: Look for text enclosed in square brackets [ and ].
Replace this placeholder text with relevant information.
* Remove Square Brackets: After replacing the placeholders, ensure to remove
the square brackets [ and ] themselves.
* Add Additional Content: If you have more Project Ideas to include, please
add them at the end of the document. Follow the provided template format for
consistency.
```

## Project Idea 1: [Project Idea 1 Title]

### Abstract

[Short summary or abstract of Project Idea 1]

### License

[Project License Name]: [Link to the project license]

### Code of Conduct

[Link to the Code of Conduct]

### Current State

[Current status or progress of Project Idea 1]

### Tasks

[List of specific tasks for Project Idea 1]

### Expected Outcomes

[Desired results or achievements for Project Idea 1]

### Details

- Prerequisites:
- [List prerequisites here]
- Expected Time: [#] hours (note: minimum 240 hours)
- Potential Mentor(s): [Mentor 1, Mentor 2, ...]
<!-- names of all potential mentors, separated by commas -->

### References

[Include any relevant links or resources for this project idea]

---

<!-- Add more project ideas below using the same template as above -->
5 changes: 5 additions & 0 deletions theme/css/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -1752,3 +1752,8 @@ a.link {
a.page-number.active {
background: #0ca5de!important;
}


.highlight *{
color: white!important;
}

0 comments on commit f996fe8

Please sign in to comment.