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

ReplayWebpage V2 Docs Content Reorganization #252

Closed
Tracked by #250
Shrinks99 opened this issue Oct 6, 2023 · 1 comment · Fixed by #278 or #269
Closed
Tracked by #250

ReplayWebpage V2 Docs Content Reorganization #252

Shrinks99 opened this issue Oct 6, 2023 · 1 comment · Fixed by #278 or #269
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Shrinks99
Copy link
Member

Shrinks99 commented Oct 6, 2023

Context

As part of #250 we want to reorganize the content of our ReplayWebpage documentation.

Proposed Hierarchy

Each Item marked by the 📰 emoji is a distinct page. Some items have been moved from distinct pages to sections on a single page. Some items (marked by ❇️) are new!

ReplayWebpage Docs
    ├── 📰 ReplayWebpage Docs Homepage
    ├── User Guide
    │   ├── 📰 User Guide Homepage
    │   │   └── Supported File Type table
    │   ├── 📰 Loading Archived Items
    │   │   └── Sharing Archived Items with Google Drive
    |   ├── 📰 Offline Use
    │   └── 📰 Exploring Web Archives
    │       ├── Pages
    │       ├── Resources
    │       ├── View Page Info (v2 feature!) ❇️
    │       └── View Archive Info ❇️
    └── Developer Docs
        ├── 📰 Embedding ReplayWebpage
        ├── 📰 Loading Content from Replay.json ❇️
        ├── 📰 Supported Location URLs
        └── 📰 Configuring CORS

Remove / move content elsewhere

  • Web Archive Collection Format Specification (link to WACZ spec where required)
  • Contact
  • Changelog
  • Examples
@Shrinks99 Shrinks99 added the documentation Improvements or additions to documentation label Oct 6, 2023
@Shrinks99 Shrinks99 self-assigned this Oct 6, 2023
@Shrinks99
Copy link
Member Author

Branch is ready, as part of 2.0 we want to change how things are published, need to look into multiple subdomains from one repo.

@Shrinks99 Shrinks99 mentioned this issue Apr 9, 2024
1 task
@Shrinks99 Shrinks99 linked a pull request Apr 9, 2024 that will close this issue
1 task
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
Status: Done!
Development

Successfully merging a pull request may close this issue.

2 participants