Guided Learning Examples
This page demonstrates the guided learning path components in action with live, interactive examples.
Basic Learning Path
The following example shows a basic guided learning path with three steps:
Getting Started with Guided Learning
Understanding the Concepts
Learn the fundamental concepts of guided learning paths
Guided learning paths provide a structured way to navigate complex topics in the documentation. They are designed to:
- Break down complexity into manageable steps
- Track progress as users move through the content
- Provide clear navigation between related concepts
- Offer visual feedback on completion status
Each step in a guided learning path focuses on a specific concept or task, making it easier to understand complex topics incrementally.
Interconnected Learning Paths
You can create interconnected learning journeys by linking from one path to another:
Advanced Guided Learning Techniques
Explore advanced usage patterns and techniques for creating complex learning journeys
Interactive Tutorial Example
The following example demonstrates a more interactive tutorial with code examples and practice exercises:
Using the RallyPoynt API
Setting Up Authentication
Learn how to authenticate with the RallyPoynt API
Before making any API requests, you need to authenticate with the RallyPoynt API:
// Import the client library
import { createClient } from '@rallypoynt/api-client';
// Create an authenticated client
const client = createClient({
apiKey: 'YOUR_API_KEY',
environment: 'development' // or 'production'
});
// Now you can make authenticated requests
const response = await client.users.getCurrentUser();
Be sure to keep your API key secure and never expose it in client-side code. For more security information, see the Security Guidelines.
Practice Exercise:
Create a new file called auth.js and set up the authentication code using your test API key.
Linking to the Next Step
After completing a learning path, you can direct users to the next relevant resource:
Complete API Reference
Explore the complete API reference documentation with detailed endpoint descriptions and examples