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 FAQ page #388

Merged
merged 7 commits into from
Jan 23, 2025
Merged

Add FAQ page #388

merged 7 commits into from
Jan 23, 2025

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Jan 16, 2025

Relates to #385 and closes #354.

Changes proposed in this pull request

  • Add FAQ page to docs.
  • Address warnings from Sphinx build process.
  • Create page for contributing guidelines in docs.

@tsalo tsalo added the documentation Improvements or additions to documentation label Jan 16, 2025
@tsalo
Copy link
Member Author

tsalo commented Jan 16, 2025

The FAQ page is showing up, but the CONTRIBUTING page (and HISTORY, and AUTHORS) is not.

Comment on lines 272 to 274
This writes out the following files:

- <output_prefix>_AcqGrouping.tsv: A tsv with the mapping of subject/session to
Copy link
Member Author

Choose a reason for hiding this comment

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

Flagged by Sphinx.

Comment on lines 112 to +113
Modifying Entity and Parameter Group Assignments
---------------------------------------------
------------------------------------------------
Copy link
Member Author

Choose a reason for hiding this comment

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

Flagged by Sphinx.

Copy link
Member Author

Choose a reason for hiding this comment

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

Linking ../CONTRIBUTING.rst through a file in docs seems to be the only way to get that content into the documentation.

@tsalo tsalo marked this pull request as ready for review January 16, 2025 18:02
@tsalo tsalo merged commit bc269f4 into main Jan 23, 2025
10 checks passed
@tsalo tsalo deleted the add-faq branch January 23, 2025 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document CuBIDS's limitations
1 participant