docs: add usage documentation #701

0xMRTT · 2023-01-13T17:42:42Z

Description

Not much to say here, we just need to create a user documentation to unclutter our repository README, and to give users more info on some features.

Fixes #699

Type of change

Bugfix (Change which fixes a issue)
New feature (Change which adds new functionality)
Enhancement (Change which slightly improves existing code)
Breaking change (This change will introduce incompatibility with existing functionality)

Changelog

Added user guide

Testing

I have tested my changes and verified that they work as expected

0xMRTT · 2023-01-13T17:43:39Z

I choosed to use the RtD theme

daudix · 2023-01-13T17:46:02Z

Can I see other themes? (maybe link to the docs's docs)

0xMRTT · 2023-01-13T17:54:17Z

It's sphinx (https://www.sphinx-doc.org/) and the theme is one of the most used: Read The Docs Theme, you can just search for Sphinx theme online

0xMRTT · 2023-01-13T18:14:09Z

So what do we want to include in the user doc ? @daudix-UFO

tfuxu · 2023-01-13T18:25:41Z

@daudix-UFO
You can check a pretty big list of curated Sphinx themes here: https://sphinx-themes.org/

daudix · 2023-01-13T18:26:35Z

I think we can change the theme later, so I will have time to look at them ;)

daudix · 2023-01-13T18:29:21Z

@0xMRTT

how to use gradience

Later when we will have website we can create a handbook, small set of guides and tips for gradience, docs will remain useful but as for new users it will be handy

E.g Vanilla OS have docs and a handbook

daudix · 2023-01-13T19:16:23Z

After looking at all themes, I think that https://sphinx-themes.org/sample-sites/furo and https://sphinx-themes.org/sample-sites/sphinx-book-theme are looking pretty neat, I like the furo the most, it also have dark mode

0xMRTT · 2023-01-14T23:22:19Z

I really like fuel to BC of the dark mode. Gonna change

tfuxu · 2023-01-14T23:46:50Z

fuel? If you meant furo, then I also agree, although I think it will need a little bit of tweaking later.

daudix · 2023-01-14T23:48:23Z

although I think it will need a little bit of tweaking later

This would be very nice! (it feels too "square", a bit of rounding will make it better)

tfuxu · 2023-01-14T23:54:14Z

it feels too "square", a bit of rounding will make it better

fr, true

0xMRTT · 2023-02-09T18:11:08Z

0xMRTT · 2023-02-09T18:30:17Z

@daudix-UFO

daudix · 2023-02-09T19:28:03Z

@0xMRTT Looks dope!

daudix · 2023-02-10T15:27:44Z

I have fixed the fonts!

Screenshot

daudix · 2023-02-10T15:53:35Z

One thing I would like to see is:

image-rendering: -webkit-optimize-contrast; /* Chromium and Safari */
image-rendering: crisp-edges;

For the sidebar gif

0xMRTT · 2023-02-10T15:57:36Z

@daudix-UFO while updating the AUR, i noticed that appstream check fail (not important but...)

3/3 Validate appstream file        FAIL            1.73s   exit status 1
>>> MALLOC_PERTURB_=80 /usr/bin/appstream-util validate /home/user/aur/gradience/src/build/data/com.github.GradienceTeam.Gradience.appdata.xml
―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― ✀  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
stdout:
/home/user/aur/gradience/src/build/data/com.github.GradienceTeam.Gradience.appdata.xml: FAILED:
• attribute-invalid     : <screenshot> width too large [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/colors_purple.png] maximum is 1600px
• attribute-invalid     : <screenshot> height too large [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/colors_purple.png] maximum is 900px
• style-invalid         : <image> has vertical padding [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/colors_purple.png]
• style-invalid         : <image> has horizontal padding [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/colors_purple.png]
• attribute-invalid     : <screenshot> width too large [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/advanced_purple.png] maximum is 1600px
• attribute-invalid     : <screenshot> height too large [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/advanced_purple.png] maximum is 900px
• style-invalid         : <image> has vertical padding [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/advanced_purple.png]
• style-invalid         : <image> has horizontal padding [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/advanced_purple.png]
• attribute-invalid     : <screenshot> width too large [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/monet_purple.png] maximum is 1600px
• attribute-invalid     : <screenshot> height too large [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/monet_purple.png] maximum is 900px
• style-invalid         : <image> has vertical padding [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/monet_purple.png]
• style-invalid         : <image> has horizontal padding [https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/monet_purple.png]
stderr:
Validation of files failed
――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――


Summary of Failures:

3/3 Validate appstream file FAIL            1.73s   exit status 1

daudix · 2023-02-10T16:03:13Z

@0xMRTT Ah, looks like screenshots are too high-res (bruh)

0xMRTT · 2023-02-10T16:58:32Z

@daudix-ufo Usage is done, could you review my work ?

daudix · 2023-02-10T17:03:17Z

Looks good, but why you removed bundled source code pro font?

it is bundled because not every distro have this font pre-installed

0xMRTT · 2023-02-10T17:10:35Z

Hhmm, i didn't removed the bundle, maybe a shit with git. Sorry :/

daudix · 2023-02-10T17:11:21Z

Hhmm, i didn't removed the bundle, maybe a shit with git. Sorry :/

Fixed, no worries

daudix · 2023-02-17T22:54:44Z

BTW, GNOME Developer Documentation uses sphinx and furo theme (how is this even possible :O), so we can just borrow it from there to have the tweaks applied by GNOME

https://gitlab.gnome.org/Teams/documentation/developer-www

0xMRTT · 2023-02-18T12:31:54Z

Lol,gonna do that 😉

0xMRTT · 2023-02-24T14:32:20Z

NOOOOOOOOOO

0xMRTT · 2023-02-24T14:32:30Z

Why i deleted that :D :/

0xMRTT · 2023-02-24T14:33:43Z

@daudix-UFO what do you think about the doc ?

daudix · 2023-02-24T14:35:25Z

I will try to add the GNOME docs style and we are ready to go!

0xMRTT · 2023-02-24T14:50:31Z

I already added

daudix · 2023-02-24T15:01:40Z

daudix · 2023-02-24T15:02:35Z

Btw, we can continue on the GradienceTeam/gradience-docs branch

0xMRTT · 2023-02-25T10:45:41Z

Moved the doc to GradienceTeam/docs and published on RTD at gradience.rtfd.io

doc: begin writing user doc

c09e656

0xMRTT added the area/documentation Improvements or additions to documentation label Jan 13, 2023

0xMRTT requested review from tfuxu and daudix January 13, 2023 17:42

0xMRTT self-assigned this Jan 13, 2023

Merge branch 'main' into sphinx-doc

7de4cf7

0xMRTT mentioned this pull request Jan 13, 2023

feat: Create user documentation #699

Closed

1 task

daudix added the status/wip Work in progress label Jan 13, 2023

Merge branch 'main' into sphinx-doc

5493d97

tfuxu added this to the 0.8.0 milestone Jan 29, 2023

feat: change to furo

0449bad

0xMRTT added 4 commits February 10, 2023 08:26

feat: add CLI

49a2c2d

fix: remove api

32d9bae

fix: change font

1557489

Merge branch 'main' into sphinx-doc

90ac13c

fix: Fonts

1b7d026

daudix and others added 5 commits February 10, 2023 19:19

misc: Change monospace font to "Source Code Pro"

a099115

misc: Rename Font

295cb86

feat: add usage

3bdc286

fix: Typos

095c4bf

feat: add usage

01183c0

feat: Cherry-pick

e2cf728

Merge branch 'main' into sphinx-doc

a9cfc86

0xMRTT closed this by deleting the head repository Feb 24, 2023

daudix changed the title ~~doc: begin writing user doc~~ docs: add usage documentation Feb 24, 2023

0xMRTT reopened this Feb 24, 2023

0xMRTT closed this Feb 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add usage documentation #701

docs: add usage documentation #701

0xMRTT commented Jan 13, 2023

0xMRTT commented Jan 13, 2023

daudix commented Jan 13, 2023 •

edited

Loading

0xMRTT commented Jan 13, 2023

0xMRTT commented Jan 13, 2023 •

edited by tfuxu

Loading

tfuxu commented Jan 13, 2023 •

edited

Loading

daudix commented Jan 13, 2023

daudix commented Jan 13, 2023 •

edited

Loading

daudix commented Jan 13, 2023

0xMRTT commented Jan 14, 2023

tfuxu commented Jan 14, 2023 •

edited

Loading

daudix commented Jan 14, 2023 •

edited

Loading

tfuxu commented Jan 14, 2023

0xMRTT commented Feb 9, 2023

0xMRTT commented Feb 9, 2023

daudix commented Feb 9, 2023

daudix commented Feb 10, 2023 •

edited

Loading

daudix commented Feb 10, 2023

0xMRTT commented Feb 10, 2023

daudix commented Feb 10, 2023 •

edited

Loading

0xMRTT commented Feb 10, 2023

daudix commented Feb 10, 2023 •

edited

Loading

0xMRTT commented Feb 10, 2023

daudix commented Feb 10, 2023

daudix commented Feb 17, 2023 •

edited

Loading

0xMRTT commented Feb 18, 2023

0xMRTT commented Feb 24, 2023

0xMRTT commented Feb 24, 2023

0xMRTT commented Feb 24, 2023

daudix commented Feb 24, 2023

0xMRTT commented Feb 24, 2023

daudix commented Feb 24, 2023

daudix commented Feb 24, 2023

0xMRTT commented Feb 25, 2023

docs: add usage documentation #701

docs: add usage documentation #701

Conversation

0xMRTT commented Jan 13, 2023

Description

Type of change

Changelog

Testing

0xMRTT commented Jan 13, 2023

daudix commented Jan 13, 2023 • edited Loading

0xMRTT commented Jan 13, 2023

0xMRTT commented Jan 13, 2023 • edited by tfuxu Loading

tfuxu commented Jan 13, 2023 • edited Loading

daudix commented Jan 13, 2023

daudix commented Jan 13, 2023 • edited Loading

daudix commented Jan 13, 2023

0xMRTT commented Jan 14, 2023

tfuxu commented Jan 14, 2023 • edited Loading

daudix commented Jan 14, 2023 • edited Loading

tfuxu commented Jan 14, 2023

0xMRTT commented Feb 9, 2023

0xMRTT commented Feb 9, 2023

daudix commented Feb 9, 2023

daudix commented Feb 10, 2023 • edited Loading

daudix commented Feb 10, 2023

0xMRTT commented Feb 10, 2023

daudix commented Feb 10, 2023 • edited Loading

0xMRTT commented Feb 10, 2023

daudix commented Feb 10, 2023 • edited Loading

0xMRTT commented Feb 10, 2023

daudix commented Feb 10, 2023

daudix commented Feb 17, 2023 • edited Loading

0xMRTT commented Feb 18, 2023

0xMRTT commented Feb 24, 2023

0xMRTT commented Feb 24, 2023

0xMRTT commented Feb 24, 2023

daudix commented Feb 24, 2023

0xMRTT commented Feb 24, 2023

daudix commented Feb 24, 2023

daudix commented Feb 24, 2023

0xMRTT commented Feb 25, 2023

daudix commented Jan 13, 2023 •

edited

Loading

0xMRTT commented Jan 13, 2023 •

edited by tfuxu

Loading

tfuxu commented Jan 13, 2023 •

edited

Loading

daudix commented Jan 13, 2023 •

edited

Loading

tfuxu commented Jan 14, 2023 •

edited

Loading

daudix commented Jan 14, 2023 •

edited

Loading

daudix commented Feb 10, 2023 •

edited

Loading

daudix commented Feb 10, 2023 •

edited

Loading

daudix commented Feb 10, 2023 •

edited

Loading

daudix commented Feb 17, 2023 •

edited

Loading