Skip to content

Commit 9602859

Browse files
authored
Re-add Documentation project ideas (#2256)
1 parent d4e421c commit 9602859

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

jsoc/gsoc/documenter.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,22 @@
33
## Documenter.jl
44

55
The Julia manual and the documentation for a large chunk of the ecosystem is generated using [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) -- essentially a static site generator that integrates with Julia and its docsystem. There are tons of opportunities for improvements for anyone interested in working on the interface of Julia, documentation and various front-end technologies (web, LaTeX).
6+
7+
Here are some features or areas that are looking for contributions:
8+
9+
* User-contributed notes and examples to documentation (e.g. backed by GitHub Discussions).
10+
* One-page-per-function documentation listings (prototype for main Julia manual). See [JuliaDocs/Documenter.jl#2133](https://github.com/JuliaDocs/Documenter.jl/issues/2133).
11+
* JuliaSyntax-based code highlighter for Julia code that can be re-used for both the HTML and LaTeX/PDF output.
12+
* Rework Documenter's page layout and navigation. See [JuliaDocs/Documenter.jl#2177](https://github.com/JuliaDocs/Documenter.jl/issues/2177).
13+
* Improve or rework Documenter's search index.
14+
* Work on any of the ideas that have been [marked as plugins](https://github.com/JuliaDocs/Documenter.jl/labels/Type%3A%20Plugin), as they offer self-contained features to work on.
15+
16+
If any of these sound interesting, please reach out to the mentors to ask for more details and to narrow down the project for a proposal. The possible projects vary in difficulty and size, depending on the project and the ultimate scope.
17+
18+
**Recommended skills**: Depends on the project, but the work would generally involved both Julia programming, but also basic web development (HTML, CSS, JS).
19+
20+
**Mentors:** [Morten Piibeleht](https://github.com/mortenpi), [Fredrik Ekre](https://github.com/fredrikekre)
21+
22+
## Contact
23+
24+
Best way to reach out is to message in the `#documentation` channel on the [JuliaLang Slack](https://julialang.org/slack/)!

jsoc/projects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ We have our project ideas organized below roughly by domain but you can also see
77
@@tight-list
88
* [Compiler](/jsoc/gsoc/compiler/) – work on the Julia compiler's internals to make things better for everyone.
99
* [CliMA](/jsoc/gsoc/clima/) – a new open-source climate model that runs on GPUs.
10-
<!--* [Documentation tooling](/jsoc/gsoc/documenter/) - Tooling related to documentation generation, docstrings etc.-->
10+
* [Documentation tooling](/jsoc/gsoc/documenter/) - Tooling related to documentation generation, docstrings etc.
1111
* [Ferrite FEM](/jsoc/gsoc/ferrite-fem/) - A modern finite element toolbox in Julia.
1212
* [Gabs](/jsoc/gsoc/gabs/) - A Gaussian quantum information simulator
1313
* [Graph neural networks](/jsoc/gsoc/gnn/) - Deep learning on graphs with GraphNeuralNetworks.jl.

0 commit comments

Comments
 (0)