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.

Sign up for GitHub

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

Jump to bottom

docs: add doc tooling and layout from starbase #296

Merged
merged 4 commits into from
Jun 16, 2023
Merged

docs: add doc tooling and layout from starbase #296

merged 4 commits into from
Jun 16, 2023

Conversation

mr-cal
Copy link
Collaborator

@mr-cal mr-cal commented Jun 8, 2023 •
edited
Loading

  • Have you signed the CLA?

A large copy-paste from starbase

Changes

  • New tox targets for docs
  • diataxis front page (reorganization)
  • Minor doc reformatting (double backticks and line lengths)
  • README.md -> README.rst
  • HACKING.rst

See #287.

(CRAFT-1726)

@mr-cal mr-cal mentioned this pull request Jun 8, 2023
Closed
13 tasks
@codecov
Copy link

codecov bot commented Jun 8, 2023 •
edited
Loading

Codecov Report

Merging #296 (c097d03) into main (8327848) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #296   +/-   ##
=======================================
  Coverage   96.69%   96.69%           
=======================================
  Files          36       36           
  Lines        2237     2237           
  Branches      305      305           
=======================================
  Hits         2163     2163           
  Misses         47       47           
  Partials       27       27

@mr-cal mr-cal mentioned this pull request Jun 8, 2023
Closed
1 task
@mr-cal mr-cal changed the title docs: add doc tooling and layout from starbase (draft): docs: add doc tooling and layout from starbase Jun 8, 2023
@mr-cal mr-cal marked this pull request as draft June 8, 2023 19:17
@mr-cal mr-cal force-pushed the docs branch 2 times, most recently from a5d9527 to 60f8ae6 Compare June 14, 2023 21:23
mr-cal added 2 commits June 15, 2023 18:24
@mr-cal
docs: add doc tooling and layout from starbase
61a6793 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal
docs: reformat README, add HACKING
c3e99cc 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal marked this pull request as ready for review June 16, 2023 00:36
@mr-cal mr-cal requested review from lengau and tigarmo June 16, 2023 00:36
@mr-cal mr-cal changed the title (draft): docs: add doc tooling and layout from starbase docs: add doc tooling and layout from starbase Jun 16, 2023
tigarmo
tigarmo approved these changes Jun 16, 2023
View reviewed changes
Copy link
Contributor

@tigarmo tigarmo left a comment

Choose a reason for hiding this comment

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

nice!

HACKING.rst Outdated Show resolved Hide resolved
@mr-cal
feedback from PR
c097d03 
Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
@mr-cal mr-cal merged commit 1e16ba5 into main Jun 16, 2023
@mr-cal mr-cal deleted the docs branch June 16, 2023 19:12
@mr-cal mr-cal mentioned this pull request Jul 3, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tigarmo tigarmo tigarmo approved these changes

@lengau lengau Awaiting requested review from lengau

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mr-cal @tigarmo