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

Removing outdated documentation and creating developer tools section #2095

Merged
merged 4 commits into from
Sep 12, 2022

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Jul 15, 2022

📝 Description

Type: 📝 documentation

Removes outdated documentation as per a discussion at TARDIScon. Users may look back in the repo if they want to see the old documentation.

Also moves two parts of the outdated documentation and the profiling documentation to a new "Developer Tools" section.

See https://tardis-sn.github.io/tardis/pull/2095/contributing/tools/index.html

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)
    Docs build pipeline.

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Jul 15, 2022

Codecov Report

Merging #2095 (dab5668) into master (79f2fc3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2095   +/-   ##
=======================================
  Coverage   61.54%   61.54%           
=======================================
  Files          75       75           
  Lines        8635     8635           
=======================================
  Hits         5314     5314           
  Misses       3321     3321           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

andrewfullard
andrewfullard previously approved these changes Jul 20, 2022
@isaacgsmith isaacgsmith marked this pull request as draft August 11, 2022 05:29
@isaacgsmith isaacgsmith force-pushed the remove_outdated_docs branch from 2847975 to dab5668 Compare August 11, 2022 18:34
@isaacgsmith isaacgsmith changed the title Removing outdated documentation Removing outdated documentation and creating developer tools section Aug 11, 2022
@isaacgsmith isaacgsmith marked this pull request as ready for review August 11, 2022 18:53
@andrewfullard andrewfullard enabled auto-merge (squash) August 15, 2022 14:07
@andrewfullard andrewfullard merged commit 782365c into tardis-sn:master Sep 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants