Improve documentation 1 to implement 1 #34

schettn · 2020-05-20T16:06:46Z

Checklist:

Have you added an explanation of what your changes do and why you'd like them to be included?
Have you updated or added documentation for the change?
Have you tested your changes with successful results?

Type of Changes:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Documentation (non-breaking change which adds documentation)
Breaking change (fix or feature that would cause existing functionality to change)

What is the current behavior? (link to any open issues here)

Currently the anchor definitions do not follow our standard. The anchors are not defined well #32
Currently the documentation does not follow our standard. The code should be adapted to the new coding guideline #33

What is the new behavior (if this is a feature change)?

Now the anchor definitions do follow our standard. Closes The anchors are not defined well #32
Now the documentation does follow our standard. Closes The code should be adapted to the new coding guideline #33

Other information:

Ref: https://githb.com/snek-at/tonic/
Ref: 🐍

Now when saving a typescript file it gets automatically formatted using prettier.

The documentation has been refined to fit the new coding style (snek-tonic). This includes setting new anchors, removing incorrect periods and some general adjustments. Ref: https://github.com/snek-at/tonic/blob/master/STYLE_GUIDE.md

Spaces in anchors have been removed due to inconsistency with the snek-tonic.

A anchor has been added to the console.error

Aichnerc

🥐 As crooked as this 𝖈𝖗𝖔𝖎𝖘𝖘𝖆𝖓𝖙.

.vscode/settings.json

src/templates/snek/gql/tasks/general.ts

src/templates/snek/gql/tasks/index.ts

@Aichnerc

The documentation quality has been improved due to q request of @Aichnerc.

The comments have been removed because GitHub does not like it.

src/endpoints/index.ts

src/endpoints/scraper.ts

src/session/index.ts

src/session/sessions.ts

src/templates/snek/gql/mutations/jwtAuth.ts

src/templates/snek/gql/mutations/user.ts

src/templates/snek/gql/queries/general.ts

src/templates/snek/gql/queries/user.ts

src/templates/snek/gql/tasks/user.ts

pinterid

Looks good after some changes.

pinterid · 2020-05-20T17:53:54Z

The type of change has to be set before merging!

@pinterid

The documentation quality has been improved due to a request of @pinterid.

src/templates/snek/gql/mutations/jwtAuth.ts

src/templates/snek/gql/mutations/user.ts

src/templates/snek/gql/queries/general.ts

src/templates/snek/gql/queries/user.ts

pinterid

Looks good after some changes.

@pinterid

The code quality has been improved due to a request of @pinterid.

pinterid

Looks good to merge.

Aichnerc

LGTM 🥞

Any changes that affect the code have been undone.

kleberbaum

Should be ok to merge after a few changes.

src/endpoints/apollo.ts

src/endpoints/index.ts

src/index.ts

src/session/sessions.ts

src/templates/snek/gql/tasks/auth.ts

@kleberbaum

The documentation quality has been improved due to a request of @kleberbaum.

kleberbaum

Should be ok to merge.

schettn added 4 commits May 20, 2020 14:26

Adjust prettier rule

33c4976

Now when saving a typescript file it gets automatically formatted using prettier.

Refine the entire project documentation

4e5384b

The documentation has been refined to fit the new coding style (snek-tonic). This includes setting new anchors, removing incorrect periods and some general adjustments. Ref: https://github.com/snek-at/tonic/blob/master/STYLE_GUIDE.md

Update package anchor

9b77674

Spaces in anchors have been removed due to inconsistency with the snek-tonic.

Add error anchor

acab607

A anchor has been added to the console.error

schettn added the documentation Improvements or additions to documentation label May 20, 2020

schettn requested review from Aichnerc and pinterid May 20, 2020 16:06

schettn self-assigned this May 20, 2020

This was linked to issues May 20, 2020

The anchors are not defined well #32

Closed

The code should be adapted to the new coding guideline #33

Closed

Aichnerc added this to Review in progress in SNEK Network for Engineers and Knowledged via automation May 20, 2020

Aichnerc requested changes May 20, 2020

View reviewed changes

schettn changed the title ~~Improve documentation 1~~ Improve documentation 1 to implement 1 May 20, 2020

Improve documentation quality

09e8769

The documentation quality has been improved due to q request of @Aichnerc.

schettn requested a review from Aichnerc May 20, 2020 16:35

Remove vscode settings documentation

5b2d660

The comments have been removed because GitHub does not like it.