From f507e223250321a5c3f6059e45eb7bb6d6d17547 Mon Sep 17 00:00:00 2001 From: blueloveTH Date: Wed, 24 Jan 2024 00:48:06 +0800 Subject: [PATCH] add GSoC application guide --- docs/gsoc/guide.md | 29 +++++++++++++++++++++++++++++ docs/gsoc/ideas.md | 5 +++++ docs/gsoc/index.yml | 2 ++ docs/quick-start/attr.md | 2 +- docs/quick-start/call.md | 2 +- docs/quick-start/config.md | 2 +- docs/quick-start/exec.md | 2 +- docs/quick-start/modules.md | 2 +- 8 files changed, 41 insertions(+), 5 deletions(-) create mode 100644 docs/gsoc/guide.md create mode 100644 docs/gsoc/ideas.md create mode 100644 docs/gsoc/index.yml diff --git a/docs/gsoc/guide.md b/docs/gsoc/guide.md new file mode 100644 index 00000000..2a2044ca --- /dev/null +++ b/docs/gsoc/guide.md @@ -0,0 +1,29 @@ +--- +icon: rocket +order: 10 +label: "Application Guide" +--- + +Before starting, please read the [Ideas](./ideas.md) page and choose a project you are interested in. +Set up a C++ compiler, clone pocketpy sources from github and try to build. +This helps you confirm that your skills and experience match the requirements of the project. + +Your application should include the following: + +1. A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link. +2. A technical proposal for the project you are interested in working on, including: + + Your understanding of the project. + + The technical approach/architecture you will adopt. + + The challenges you might face and how you will overcome them. +3. A timeline for the project, including the milestones and deliverables. +4. Other information required by the Google Summer of Code program. + +### Coding style guide + +See [Coding Style Guide](../coding_style_guide.md). + +### Contact + +If you have any questions, you can join our [Discord](https://discord.gg/WWaq72GzXv) +or send an email to blueloveth@foxmail.com. +We are glad to help you. \ No newline at end of file diff --git a/docs/gsoc/ideas.md b/docs/gsoc/ideas.md new file mode 100644 index 00000000..8ba90aff --- /dev/null +++ b/docs/gsoc/ideas.md @@ -0,0 +1,5 @@ +--- +icon: light-bulb +order: 0 +label: "Project Ideas" +--- \ No newline at end of file diff --git a/docs/gsoc/index.yml b/docs/gsoc/index.yml new file mode 100644 index 00000000..0fd22c4b --- /dev/null +++ b/docs/gsoc/index.yml @@ -0,0 +1,2 @@ +order: 19 +label: "GSoC" \ No newline at end of file diff --git a/docs/quick-start/attr.md b/docs/quick-start/attr.md index 365d7979..b8154c2f 100644 --- a/docs/quick-start/attr.md +++ b/docs/quick-start/attr.md @@ -1,6 +1,6 @@ --- icon: dot -label: 'Access attributes' +label: 'Access Attributes' order: 80 --- diff --git a/docs/quick-start/call.md b/docs/quick-start/call.md index 2e3e06ad..bbfc2a23 100644 --- a/docs/quick-start/call.md +++ b/docs/quick-start/call.md @@ -1,6 +1,6 @@ --- icon: dot -label: 'Call Python function' +label: 'Call Python Function' order: 70 --- diff --git a/docs/quick-start/config.md b/docs/quick-start/config.md index 18c4b117..bf546a76 100644 --- a/docs/quick-start/config.md +++ b/docs/quick-start/config.md @@ -1,6 +1,6 @@ --- icon: dot -label: 'Advanced config' +label: 'Advanced Config' order: -2 --- diff --git a/docs/quick-start/exec.md b/docs/quick-start/exec.md index 849c3276..310afa23 100644 --- a/docs/quick-start/exec.md +++ b/docs/quick-start/exec.md @@ -1,6 +1,6 @@ --- icon: dot -label: 'Execute Python code' +label: 'Execute Python Code' order: 93 --- diff --git a/docs/quick-start/modules.md b/docs/quick-start/modules.md index 396c0a67..722c9afe 100644 --- a/docs/quick-start/modules.md +++ b/docs/quick-start/modules.md @@ -1,6 +1,6 @@ --- icon: dot -label: 'Create modules' +label: 'Create Modules' order: 50 ---