Skip to content

docs: Update how to access oppia webpages#520

Open
riyaseema80 wants to merge 30 commits intooppia:developfrom
riyaseema80:update-how-to-access-oppia-webpages
Open

docs: Update how to access oppia webpages#520
riyaseema80 wants to merge 30 commits intooppia:developfrom
riyaseema80:update-how-to-access-oppia-webpages

Conversation

@riyaseema80
Copy link
Copy Markdown

@riyaseema80 riyaseema80 commented Mar 14, 2026

Overview

This PR adds a comprehensive Oppia Dev Server Guide to help contributors understand how to navigate and use the local development environment.
The guide documents the major pages, dashboards, routes, and workflows available in Oppia, and provides screenshots and step-by-step instructions for common tasks.

What this PR includes

  • Overview of core Oppia entities (Classroom, Topic, Story, Chapter, Card)
  • Explanation of important user account and admin pages
  • Documentation for creator and contributor dashboards
  • Guide to generating data on the local development server
  • Routing reference for contributors with guard explanations
  • Screenshots for key pages to help new contributors navigate the UI
  • Table of Contents for easier navigation through the guide

Why this is useful

This documentation helps:

  • new contributors understand the Oppia dev server
  • contributors find important routes quickly
  • developers debug routing or role-based access issues

Testing

  • Verified all internal links and anchors in the document
  • Confirmed images render correctly in Markdown preview

Screenshots

Multiple screenshots have been added to illustrate important pages such as:

  • Admin panel
  • Creator dashboard
  • Contributor dashboard
  • Skill editor
  • Topic editor

Fix Issue :#477

@HardikGoyal2003 HardikGoyal2003 self-requested a review March 16, 2026 08:29
Copy link
Copy Markdown
Member

@HardikGoyal2003 HardikGoyal2003 left a comment

Choose a reason for hiding this comment

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

@riyaseema80 Thanks a lot for the PR. I have reviewed it till super-admins part and left a few comments. Once you fix them, feel free to ask for another review.

@riyaseema80
Copy link
Copy Markdown
Author

Hi @HardikGoyal2003 I’ve addressed the requested changes and updated the document accordingly. Please let me know if anything else needs to be modified. Thanks!

Copy link
Copy Markdown
Member

@HardikGoyal2003 HardikGoyal2003 left a comment

Choose a reason for hiding this comment

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

@riyaseema80 Left a few comments. Can you also arrange the content inside Oppia Webpages and Public informational pages in lexicographical order?

@riyaseema80
Copy link
Copy Markdown
Author

@HardikGoyal2003 Thanks for the review! I’ve addressed the new comments — removed the line, updated the super admin description, formatted the pages as suggested, and arranged the sections in lexicographical order. Please take another look when you have time.

Correct capitalization in headings and steps for consistency throughout the document.
@riyaseema80
Copy link
Copy Markdown
Author

Hi @HardikGoyal2003, I’ve updated the Steps to Access formatting across the document based on your suggestion. Please let me know if it looks correct or if any further changes are needed. Thanks!

Copy link
Copy Markdown
Member

@HardikGoyal2003 HardikGoyal2003 left a comment

Choose a reason for hiding this comment

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

Left a few more comments: A few things to fix are:

  • Pages that have tabs should follow this format in the lexicographical order (Note: You don't need to add tabs in the table of contents. Adding `Important admin page tabs`` is sufficient)
  • Make the Tab names proper across the docs. For eg: Tab name is Roles Tab but you have named it as Assign Roles, so fix this across the docs.
  • In the permissions required, you have mentioned super-admin only. Update it to [Super Admin](https://github.com/oppia/oppia-web-developer-docs/blob/df4319b52bf61b4aa33a2944903bfa3bea1b9544/How-to-access-Oppia-webpages.md#log-in-as-a-super-administrator)

@riyaseema80
Copy link
Copy Markdown
Author

Thanks for the detailed feedback! I have updated all tab sections to follow the same format, ensure they are arranged in lexicographical order, fix tab naming consistency across the document, and update permissions to use the Super Admin reference.

@riyaseema80
Copy link
Copy Markdown
Author

riyaseema80 commented Mar 17, 2026

Hi @HardikGoyal2003, I’ve updated the doc structure as suggested.

Copy link
Copy Markdown
Member

@HardikGoyal2003 HardikGoyal2003 left a comment

Choose a reason for hiding this comment

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

I have completed a review till the exploration editor page.

@riyaseema80
Copy link
Copy Markdown
Author

i have improved page descriptions, fixed routes, and added data generation steps for pages. Thanks!

Copy link
Copy Markdown
Member

@HardikGoyal2003 HardikGoyal2003 left a comment

Choose a reason for hiding this comment

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

I have reviewed everything before the populating data heading.

Removed outdated links and improved clarity in navigation instructions throughout the document.
@riyaseema80
Copy link
Copy Markdown
Author

Hi @HardikGoyal2003,
All comments have been addressed — updated links, fixed URLs/descriptions, removed redundant sections, corrected steps, added notes for dev features, and included required images/data generation.
Please review once. Thanks!

Copy link
Copy Markdown
Member

@HardikGoyal2003 HardikGoyal2003 left a comment

Choose a reason for hiding this comment

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

@riyaseema80

  • Can you please fix the formatting of the table of contents?
image
  • Can you also fix the formatting for the manual steps in populating data, like: #520 (comment)

Comment on lines +1567 to +1583
- To populate the Explorations:
- **Quick method:** Use Generate Dummy Explorations OR Reload a Single Exploration in [Activities tab](#activities-tab).

The exploration player page allows users to play explorations in Oppia.
- **Manual method:**

1. Navigate to http://localhost:8181/community-library.
Step 1. Open Creator Dashboard.
Go to: http://localhost:8181/creator-dashboard
Click: “Create Exploration”

2. Enter "fractions" into the search bar.
Step 2. Choose Interaction Type
You will be asked to select:
- Multiple Choice
- Text Input
- Fraction Input
- Drag & Drop
- Image Selection, etc.
Click Create
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  • To populate the Explorations:
    • Quick method: Use Generate Dummy Explorations OR Reload a Single Exploration in Activities tab.
    • Manual method:
      • Open Creator Dashboard or Go to: http://localhost:8181/creator-dashboard
      • Click: “Create Exploration”
      • Choose Interaction Type. You will be asked to select from Multiple Choice, Text Input, Fraction Input,, etc.
      • Click Create

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.

2 participants