Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section about config files in the Launcher tutorial #671

Merged
merged 5 commits into from
Sep 8, 2023

Conversation

pieqq
Copy link
Collaborator

@pieqq pieqq commented Aug 21, 2023

Description

  • Add section about config files in the Launcher tutorial

    Instead of writing a whole separate tutorial section about config files,
    a section is created within the tutorial about launchers. This section
    briefly touches on config files and point to the existing explanation
    for more information.

  • Add section about check-config in the config explanation

Resolved issues

CHECKBOX-752

Documentation

See the pages /explanation/configs/ and /tutorial/using-checkbox/basic-launcher/#a-note-about-config-files when running the live build with make run to see the rendered version of the pages.

Tests

make clean-doc && make spelling && make linkcheck && make woke

Instead of writing a whole separate tutorial section about config files,
a section is created within the tutorial about launchers. This section
briefly touches on config files and point to the existing explanation
for more information.

Fix CHECKBOX-752
@pieqq pieqq force-pushed the CHECKBOX-752/checkbox-config-tutorial branch from 8705502 to b35d25f Compare August 31, 2023 02:25
@pieqq pieqq requested review from tang-mm and Hook25 August 31, 2023 02:58
@pieqq pieqq changed the title Checkbox 752/checkbox config tutorial Add section about config files in the Launcher tutorial Sep 6, 2023
docs/explanation/configs.rst Outdated Show resolved Hide resolved
docs/explanation/configs.rst Show resolved Hide resolved
docs/explanation/configs.rst Show resolved Hide resolved
docs/tutorial/using-checkbox/basic-launcher.rst Outdated Show resolved Hide resolved
docs/tutorial/using-checkbox/basic-launcher.rst Outdated Show resolved Hide resolved
@pieqq pieqq requested a review from tang-mm September 8, 2023 06:04
Copy link
Collaborator

@tang-mm tang-mm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@pieqq pieqq merged commit 4e1d282 into main Sep 8, 2023
14 checks passed
@pieqq pieqq deleted the CHECKBOX-752/checkbox-config-tutorial branch September 8, 2023 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants