| title | layout | last_modified_date | nav_order | status | language | short-title | project | tags | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PROJECT-NAME - EXAMPLE-NAME [LANGUAGE] |
default |
20XX-XX-XXTXX:XX:XX+XXXX |
BIGGEST-USED-NAV-ORDER + 1 |
DRAFT |
e.g. Java |
title without the name of the project and the language |
|
|
{% include article-meta.html article=page %}
Give a high-level description of the project. Explain the part(s) of it that include the example in more detail.
Explain the problem solved by the featured code example.
Give an overview of the code. What it does, how it works, what patterns it employs, etc.
Dive deeper into the implementation. Include code snippets. Insert them as-is, except remove irrelevant details when necessary. Add permalinks to everything.
Describe how it's tested. Include snippets and links.
Add more observations about the code. Optional. Consider writing observations in relevant sections of "Implementation details".
Discuss similar and/or related implementations. Optional.
Add references to relevant documents.
What license is the project under.
Who owns the copyright.