Skip to content

Refactor Sphinx docs following Diátaxis #210

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.

Sign up for GitHub

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

Draft
vmdocua wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Refactor Sphinx docs following Diátaxis #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
076e2dd
Updated AI context with diataxis docs notes and pattern.
vmdocua Dec 12, 2025
c013c16
Update .ai/context.md
vmdocua Dec 12, 2025
5aa3225
Upgrade psychopy linux installer to v2.2.5, #210.
vmdocua Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .ai/context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,15 @@ docs/source/
- SVG-based ReproFlow diagram
- Platform-specific notes (Linux, macOS, Windows)

**Documentation Pattern - Diátaxis:**
Documentation follows (or is being refactored to follow) the [Diátaxis framework](https://diataxis.fr/), which organizes documentation into four categories:
- **Tutorials**: Learning-oriented, step-by-step lessons for beginners
- **How-to Guides**: Task-oriented, goal-focused recipes for specific problems
- **Reference**: Information-oriented, technical descriptions (API docs, CLI reference)
- **Explanation**: Understanding-oriented, clarifying discussions about design and context

*Note: Current documentation is in an older style and is being gradually refactored to align with Diátaxis principles for improved usability and maintainability.*

#### `containers/` - Container Definitions
Docker and Singularity container support for deployment.

Expand Down
2 changes: 1 addition & 1 deletion containers/repronim-reprostim/setup_container.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ PSYCHOPY_VENV_BIN=${PSYCHOPY_HOME}/.venv/bin

# Install psychopy_linux_installer from GitHub
echo "Install psychopy_linux_installer from GitHub..."
git clone --branch v2.2.4 --depth 1 https://github.com/wieluk/psychopy_linux_installer/ /opt/psychopy-installer
git clone --branch v2.2.5 --depth 1 https://github.com/wieluk/psychopy_linux_installer/ /opt/psychopy-installer
cd /opt/psychopy-installer

# Install PsychoPy via psychopy_linux_installer
Expand Down
Loading