Skip to content

Conversation

@desilinguist
Copy link
Collaborator

@desilinguist desilinguist commented Jul 25, 2023

  • Use sphinx_design in docs.
  • Remove outdated note from api.rst.
  • Add references needed by FAQ page.
  • Add FAQ page with first set of questions.

Happy to take suggestions of additional things that we should put in the FAQ.

Here's the FAQ page as built by read the docs: https://rsmtool.readthedocs.io/en/547-add-faq-to-docs/faq.html

@codecov
Copy link

codecov bot commented Jul 25, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (a0fce2c) 95.88% compared to head (f0e754d) 95.88%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #622   +/-   ##
=======================================
  Coverage   95.88%   95.88%           
=======================================
  Files          60       60           
  Lines        9348     9348           
=======================================
  Hits         8963     8963           
  Misses        385      385           

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

Copy link
Member

@damien2012eng damien2012eng left a comment

Choose a reason for hiding this comment

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

LGTM! All links are tested.

@desilinguist desilinguist linked an issue Jul 25, 2023 that may be closed by this pull request
@desilinguist desilinguist merged commit 8dbba12 into main Jul 25, 2023
@delete-merged-branch delete-merged-branch bot deleted the 547-add-faq-to-docs branch July 25, 2023 21:05
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.

Create FAQ page with common questions

4 participants