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

feat: init mdbooks for specs site with place holder files #1199

Merged
merged 2 commits into from
Sep 20, 2023

Conversation

MSevey
Copy link
Contributor

@MSevey MSevey commented Sep 20, 2023

Overview

This PR adds mdbook for hosting the specs site. A workflow was added to deploy the specs site to github pages.

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@github-actions
Copy link

github-actions bot commented Sep 20, 2023

PR Preview Action v1.4.4
🚀 Deployed preview to https://rollkit.github.io/rollkit/pr-preview/pr-1199/
on branch gh-pages at 2023-09-20 14:38 UTC

@MSevey MSevey force-pushed the sevey/mdbooks-specs branch 2 times, most recently from 80971ca to 6a2c006 Compare September 20, 2023 10:15
@MSevey MSevey force-pushed the sevey/mdbooks-specs branch from 6a2c006 to edac698 Compare September 20, 2023 10:18
@MSevey MSevey added the T:documentation Improvements or additions to documentation label Sep 20, 2023
@MSevey MSevey marked this pull request as ready for review September 20, 2023 10:20
@codecov
Copy link

codecov bot commented Sep 20, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.01% 🎉

Comparison is base (92d41e5) 56.04% compared to head (d0023d6) 56.05%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1199      +/-   ##
==========================================
+ Coverage   56.04%   56.05%   +0.01%     
==========================================
  Files          63       63              
  Lines        6695     6695              
==========================================
+ Hits         3752     3753       +1     
  Misses       2556     2556              
+ Partials      387      386       -1     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@nashqueue nashqueue left a comment

Choose a reason for hiding this comment

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

Thank you , LGTM apart from 3 nits

specs/README.md Outdated Show resolved Hide resolved
specs/template.md Outdated Show resolved Hide resolved
specs/template.md Outdated Show resolved Hide resolved
@MSevey MSevey requested a review from nashqueue September 20, 2023 14:38
@nashqueue nashqueue added this pull request to the merge queue Sep 20, 2023
Merged via the queue into main with commit 667cec7 Sep 20, 2023
@nashqueue nashqueue deleted the sevey/mdbooks-specs branch September 20, 2023 20:58
gupadhyaya pushed a commit that referenced this pull request Sep 22, 2023
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 
-->

This PR adds
[mdbook](https://rust-lang.github.io/mdBook/guide/installation.html) for
hosting the specs site. A workflow was added to deploy the specs site to
github pages.

## Checklist

<!-- 
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords

---------

Co-authored-by: nashqueue <[email protected]>
chandiniv1 pushed a commit to chandiniv1/rollkit that referenced this pull request Sep 25, 2023
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 
-->

This PR adds
[mdbook](https://rust-lang.github.io/mdBook/guide/installation.html) for
hosting the specs site. A workflow was added to deploy the specs site to
github pages.

## Checklist

<!-- 
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords

---------

Co-authored-by: nashqueue <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants