https://www.cpp-lang.net/tools/standalone/editors/setup-clion/

To do:

• installation process
• creating a project
• building and running project with a basic code
• (optionally) some tips and tricks for beginners

We'll probably use Algolia DocSearch.

Containers

• #21
• #22
• #23
• #24
• #25
• #26
• #27
• #28
• #29
• #30
• #31
• #32
• #33
• #34
• #35
• #36
• #37

Default code highlighting is limited. Where possible we should add custom type hints to properly color a token.

Status

• tokenization hook for // prism-push-types:Type1,Type2,Type3
• we'll have to fix:
  facebook/docusaurus#8550

The problem

Example: Enemy token should be manually marked as a class name for better preview

How it should be done:

// prism-push-types:Enemy
int main()
{
    Enemy boss;
}

Result preview:

I'll take it

If we want to make the contribution easier for other people we need to translate the basic information about contributing to other languages. I am down to translate the page to polish.

We'll probably use Algolia Search Bar.

Before we do that

The problem is that we now have a lot of unfinished documentation. I want at least one of the following to be complete before we install it:

1. the beginner level course
2. std library containers docs

Overview

Rework the lesson structure, split into sublessons (examples, exercises, etc.)

Functions

• Lesson structure
  • Motivation
  • Introduction
  • Creating functions
    • a basic example without parameters (a procedure)
    • with parameters
    • return statement
    • returning a value
    • Declaration and definition
  • Overloading (basics)
  • Summary
• 💡 Examples
  • calculate area of a circle
  • convert Fahrenheit to Celsius
  • calculate factorial of a number
  • average value of array of numbers
  • calculate gcd
  • calculate a power of a number (exponent is a positive integer)
  • reverse a string
  • check if a string is a palindrome
• 💢 Common problems
  • incorrect number or type of arguments
  • not returning a value
  • missing declaration
• 📚 Exercises
  • count occurrences of a character in a string
  • count number of vowels in a string
  • detect if string is an anagram
  • convert int to string

Their license permits that.
We'll have to mention them in Useful links.

We'll have to contact the authors as well, maybe they will be willing to help us :)

Current status

• #4
• #5
• #3
• #6
• #7
• #8
• #9
• #10
• #11
• #12
• #13

Visual Studio 2022 Setup:

• Installation
• Creating Projects
• Using Debugger
• Managing projects

Clang Setup:

• Clang Setup

Description:

https://www.cpp-lang.net/tools/standalone/compilers/setup-gcc-windows/

One of the green helper cards has Polish in it. This should be translated to English.

"Przeczytaj poniższy artykuł by dowiedzieć się, jak dodać ścieżkę do zmiennej systemowej PATH:"

Part I:

• Definition
• std::count_if()
• std::transform()

Part II:

• std::function
• std::for_each()
• keyword "mutable" in lambdas declaration
• throw exceptions from lambdas

Randomness

General

• translate from Polish to English

Localized versions

Polish

• a better info about <random> that discourages usage of std::rand in the future. (@Fureeish)

A language doc about lambdas.

• main article

• fixing typos

std::array reference

Main page

• overview
• technical details
• top examples (simple)
• bottom examples (complex)

Methods

• constructors
• destructors
• operator=
• .at()
• operator[]
• .front()
• .back()
• .data()
• .begin() / .cbegin()
• .end() / .cend()
• .rbegin() / .crbegin()
• .rend() / .crend()

Some containers miss examples in their documentations (both basic and advanced ones), have very few of them or are poorly written/full of typos, whatever.

Some of them also need a refactoring of other sections (proper formatting, fixing typos, etc.)

Overview

Make the lesson structure fit the following (note the actual names of the course lessons are in bold):

Arrays

• 1. Introduction
  • Motivation: why do we want to use them.
  • Arrays in C++: types of arrays in the language
• 2. Dynamic arrays
  • Lesson structure
    • creating a vector
    • accessing elements
    • adding elements
    • removing elements
    • reading size
    • displaying elements
  • 💡 Examples
  • 💢 Common problems
  • 📚 Exercises
• 3. Fixed-size arrays
  • Lesson structure
    • creating an array
    • accessing elements
    • note about not being able to add or remove elements
    • filling the content
    • reading size, mention that it is always the same
    • displaying elements
  • 💡 Examples
  • 💢 Common problems
  • 📚 Exercises
• 4. Using algorithms - show examples that require minimal knowledge of the language but allow the reader to play with vectors and arrays
  • max value with std::ranges::max()
  • min value with std::ranges::min()
  • reverse with std::ranges::reverse()
  • sorting with std::ranges::sort()
  • ensure the lesson properly shows both std::array and std::vector examples
• 5. C-style arrays
  • explain why we don't want to use C-style arrays
  • describe when and how to use safer alternatives instead
  • provide basic examples of C-style array usage
• 📚 Exercises

Opening an issue so multiple people don't accidentally work on the same article in the same time.

Minimal plan

https://cpp-lang.net/stddraft/

should redirect to

https://eel.is/c++draft/

or embed it, if we're going to add some nice features.

Maximal plan

Self-host the generation of the document.

It would be a nice improvement if you could add an additional button (besides the copy button) that directly opens the current code snippet in a new https://godbolt.org/ tab.