PathCurator Documentation

1. Name: Give your pathway a clear, descriptive title
2. Description: Use markdown to describe the pathway's goals and audience
3. Metadata: Add tags, difficulty level, and estimated time
4. Structure: Plan the logical sequence of steps

1. Visit the Bookmarklet page
2. Drag the "Add to PathCurator" button to your bookmarks bar
3. If your bookmarks bar isn't visible, press Ctrl+Shift+B (or Cmd+Shift+B on Mac)

1. Navigate to any webpage you want to add
2. Click the "Add to PathCurator" bookmark in your bookmarks bar
3. Choose the pathway and step where you want to add the resource
4. Edit the title, description, and classification as needed
5. Click "Add Bookmark" to save

PathCurator's auditing system:

• Checks all bookmark URLs.
• Tests HTTP status codes to verify availablity.
• Detects redirects and updates URLs when appropriate.
• Report dashboard showing status of links and shortcuts to update.

Running Link Audits

1. Visit the Audit page from the navigation menu
2. Click "Audit All Links"
3. Watch real-time progress as links are checked
4. Review results and take action on broken links

Some sites (like Quora or Medium) block automated requests but work fine in browsers. You can mark these as "exempt" to avoid false positives:

1. In the audit results, find the problematic link
2. Click "Mark as Exempt"
3. The link will be excluded from future error reports

1. Visit GitHub Settings
2. Create a GitHub Personal Access Token - View step-by-step guide
3. Enter your token in PathCurator settings
4. Select a repository for storing your pathways
5. Choose a branch and file path
6. Test the connection

1. Enable GitHub Pages: Go to your repository settings on GitHub and enable Pages for your repository
2. Choose Source: Select "Deploy from a branch" and choose your main/master branch
3. Configure PathCurator: In GitHub Settings, ensure your repository and file paths are set correctly
4. Test Connection: Verify your GitHub integration is working

Import previously exported PathCurator data:

1. Click "Import JSON" on the dashboard
2. Select your JSON file
3. Review conflicts and choose merge strategy
4. Confirm import

Sync pathways from your GitHub repository:

1. Ensure GitHub integration is set up
2. Click "Import from GitHub"
3. Choose how to handle conflicts
4. Optionally use GitHub pathway order

• Automatic Version Generation: Every change to a pathway triggers a new version number automatically
• Content-Based Hashing: Version numbers are generated based on the actual content of your pathway, ensuring unique identifiers for each state
• No Manual Intervention Required: Versioning happens seamlessly in the background whenever you save changes

Any modification to the following elements will automatically trigger a new version:

• Pathway name or description
• Adding, removing, or modifying steps
• Adding, removing, or modifying bookmarks within steps
• Updating content warnings or acknowledgments
• Changing bookmark URLs, titles, descriptions, or context
• Reordering steps or bookmarks
• Updating step objectives or descriptions

Versions are formatted as HASH-DATE where:

• HASH: A unique 6-character identifier derived from the pathway content
• DATE: The date when the version was created (YYYY-MM-DD format)

The hash ensures that even if multiple changes happen on the same day, each version remains unique.

PathCurator maintains a comprehensive history of your pathway changes:

• Last 10 Versions: The system keeps the most recent 10 versions of each pathway
• Version Entry Details: Each version entry includes:
  • Version hash
  • Timestamp of the change
  • Number of steps at that version
  • Number of bookmarks at that version
  • Username of the person who made the change (when GitHub integration is enabled)
• Export Preservation: Version history is preserved when exporting and importing pathways
• Git History: Previous versions remain accessible in your Git history when using GitHub integration