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 documentation #330

Merged
merged 13 commits into from
Mar 7, 2023
Merged

Add documentation #330

merged 13 commits into from
Mar 7, 2023

Conversation

waybackarchiver
Copy link
Contributor

@waybackarchiver waybackarchiver commented Mar 6, 2023

Description

We use mkdocs to create the wayback documentation, which can be published on GitHub Pages. To do this, needs to enable this feature for the repository and set a custom domain.


Issue Ticket Number

Close #165
Relates to #273


Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

  • I have followed the contributing guidelines of this project as mentioned in CONTRIBUTING.md
  • I have checked to ensure there aren't other open Pull Requests for the same update/change?
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes needed to the documentation

.github/workflows/pages.yml Fixed Show fixed Hide fixed

- name: Install Requirements
run: |
pip install -r requirements.txt

Check warning

Code scanning / Scorecard

Pinned-Dependencies

score is 7: pipCommand not pinned by hash Click Remediation section below to solve this issue
@waybackarchiver waybackarchiver marked this pull request as ready for review March 7, 2023 03:41
@codecov
Copy link

codecov bot commented Mar 7, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.39 ⚠️

Comparison is base (08cb62c) 45.50% compared to head (e1c6f00) 45.11%.

❗ Current head e1c6f00 differs from pull request most recent head 8ed7976. Consider uploading reports for the commit 8ed7976 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #330      +/-   ##
==========================================
- Coverage   45.50%   45.11%   -0.39%     
==========================================
  Files          56       56              
  Lines        5193     5193              
==========================================
- Hits         2363     2343      -20     
- Misses       2571     2593      +22     
+ Partials      259      257       -2     
Impacted Files Coverage Δ
service/telegram/telegram.go 32.95% <0.00%> (-6.54%) ⬇️
publish/nostr/nostr.go 40.22% <0.00%> (-2.30%) ⬇️
service/slack/slack.go 5.57% <0.00%> (+0.58%) ⬆️
service/twitter/twitter.go 35.97% <0.00%> (+2.15%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@waybackarchiver waybackarchiver merged commit 79b191c into main Mar 7, 2023
@waybackarchiver waybackarchiver deleted the docs branch March 7, 2023 08:37
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.

Constructing full documentation
1 participant