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

Iteration1 #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Iteration1 #2

wants to merge 1 commit into from

Conversation

Update

Signed-off-by: Danie0918 <[email protected]>
@Danie0918 Danie0918 changed the title Update PRD.md Iteration1.md Jul 27, 2023
@Danie0918 Danie0918 changed the title Iteration1.md Iteration1 Jul 27, 2023
@Danie0918
Copy link
Collaborator Author

Danie0918 commented Jul 27, 2023

【General】

  1. Website Architecture
  • The website has Magickbase as the first level domain name and the official website of its services as the second level domain name.
  • Domain rules: service name.magickbase.com/name of the page file under the service.
  1. Top Navigation

top_navigation

  • [Logo] Located in the upper left corner of the page, displaying the name of the current page (service pages need to provide the official website jump logo), page sliding navigation bar fixed top.
  • [Menu] Tap to swipe left to bring up a menu that provides navigation and global settings.
  1. Bottom Column

bottom_column

  • [Logo] Click to jump to the Magickbase home page.
  • [Status and Service Monitor] Displays the overall status of the current services under Magickbase and can be clicked to access the service monitor page.
  • [Services] Click the name to jump to the corresponding service homepage.
  • [Foundation] Provide the foundation external link, click to jump to the foundation home page.

@Danie0918 Danie0918 self-assigned this Jul 27, 2023
@Danie0918 Danie0918 added the documentation Improvements or additions to documentation label Jul 27, 2023
@Danie0918
Copy link
Collaborator Author

【Home】

home

  1. Branding Screen
    The first screen displays fixed copy for brand promotion (slogan + introduction), supports language switching, and switches to the next screen by sliding.

  2. About Us
    Show team spirit, fixed copy (headline + body), support language switching, scroll to show vision, mission, future when sliding the page, keep sliding to switch to the next screen.

  3. Services
    Display the services under the organization (name + description) and click new window to go to the services home page.

  4. Contact Us
    Contact us (promotional text + contact information), click to display the corresponding contact information.

@Danie0918
Copy link
Collaborator Author

【Neuron】

  1. Home

neuron

Split-screen introduction to Neuron Wallet features, providing introductory copy and preview images to guide users to download the wallet.

  1. Changelog

Neuron_changelog

  • [Data Source] Get the github release page to update the text, provide a link to jump to view the corresponding issue.
  • [Sort] In descending order of version release.
  • [Paging] Load up to 5 screens of content in a single load, beyond which you will need to turn the page to view.
  • [Back to top] Provides a back to top button to click to return to the top of the page after the page has slid beyond one screen.
  • [Tip] Add a marker line at the bottom of the earliest update in the document to indicate to the user that there is "no more content".
  1. Help Center

help_center

  • [Home] Display titles and provide searches based on captured documents.
  • [Search Results] Fuzzy match search document title and content and provide a preview, display results when not matched and provide contact information.
  • [Document] The content of issues and discussions on github is collected through algolia and divided into newbie guides, FAQs and announcements.
  1. Download

download

  • [Resource] Get the latest release resources from github.
  • [List] Categorized by system, architecture, and package type, Checksum is provided to help check downloaded packages.

@Danie0918
Copy link
Collaborator Author

【CKB Explorer】CKB Explorer Portal - Help users to understand CKB Explorer and record CKB Explorer updates.

  1. Home

ckb_explorer

Split-screen introduction to CKB Explorer features, providing introductory copy and preview images to direct users to CKB Explorer.

  1. Changelog

ckb_changelog

[Data Source] Get github to update issues and titles, providing jump links to view the appropriate issues.
[Sort] Sorted in descending order of time.
[Paging] Load up to 5 screens of content in a single load, beyond which you will need to turn the page to view.
[Back to top] Provides a back to top button to click to return to the top of the page after the page has slid beyond one screen.
[Tip] Add a marker line at the bottom of the earliest update in the document to indicate to the user that there is "no more content".

@Danie0918
Copy link
Collaborator Author

【Godwoken Explorer】Godwoken Explorer Portal - Help users to understand Godwoken Explorer and record Godwoken Explorer updates.

  1. Home

godwoken_explorer

Split-screen introduction to Godwoken Explorer features, providing introductory copy and preview images to direct users to Godwoken Explorer.

  1. Changelog

godwoken_explorer

[Data Source] Get github to update issues and titles, providing jump links to view the appropriate issues.
[Sort] Sorted in descending order of time.
[Paging] Load up to 5 screens of content in a single load, beyond which you will need to turn the page to view.
[Back to top] Provides a back to top button to click to return to the top of the page after the page has slid beyond one screen.
[Tip] Add a marker line at the bottom of the earliest update in the document to indicate to the user that there is "no more content".

@Danie0918
Copy link
Collaborator Author

【Axon Explorer】Axon Explorer Portal - Help users to understand Axon Explorer and record Axon Explorer updates.

  1. Home

axon_explorer

Split-screen introduction to Axon Explorer features, providing introductory copy and preview images to direct users to Axon Explorer.

  1. Changelog

axon_changelog

[Data Source] Get github to update issues and titles, providing jump links to view the appropriate issues.
[Sort] Sorted in descending order of time.
[Paging] Load up to 5 screens of content in a single load, beyond which you will need to turn the page to view.
[Back to top] Provides a back to top button to click to return to the top of the page after the page has slid beyond one screen.
[Tip] Add a marker line at the bottom of the earliest update in the document to indicate to the user that there is "no more content".

@Danie0918
Copy link
Collaborator Author

【Kuai】Kuai Portal - Help users to understand Kuai and record Kuai updates.

  1. Home

kuai

Split-screen introduction to Kuai features, providing introductory copy and demo to direct users to Kuai.

  1. Changelog

kuai_changelog

[Data Source] Get github to update issues and titles, providing jump links to view the appropriate issues.
[Sort] Sorted in descending order of time.
[Paging] Load up to 5 screens of content in a single load, beyond which you will need to turn the page to view.
[Back to top] Provides a back to top button to click to return to the top of the page after the page has slid beyond one screen.
[Tip] Add a marker line at the bottom of the earliest update in the document to indicate to the user that there is "no more content".

@Danie0918
Copy link
Collaborator Author

【Service Monitor】Service monitoring page that provides a summary of online service monitoring data.

  1. Home

service_monitor

Displays the overall status of the service and the status of each of its subordinate services (Public Node, CKB Explorer, Godwoken Explorer, and Faucet) for the last 90 days.(Data sources:https://status.magickbase.com/)

  1. Index

index

Provides service index detail charts, currently supports CKB Explorer and Godwoken Explorer.

[Data Sources] https://grafana.layerview.io/d/gEWc1Gq4k/ckb-dashboard?orgId=1&from=now-5m&to=now&refresh=5s
[Content Display] Embedded in a fixed position on the page, click on the zoom button to view the enlarged chart.

  1. History Events

history_events

Record historical events for each service to help users access and understand how problems occurred and were resolved over time.

[Data Sources] https://status.magickbase.com/incidents
[Sort] Sorted in descending order of time.
[Content Display] Display the start and end time, title and label of the event in a table, and hover over the entry to display the details.

@Danie0918
Copy link
Collaborator Author

[Service Monitor]

Here the original public node page has been expanded to introduce new service indicator charts to form a new web page.This preserves the original data and expands and categorizes it, how about this solution? @Keith-CY @Sven-TBD

@Keith-CY
Copy link
Member

Mentioning the Service Monitor -> Status status and Service Monitor -> History Incidents

There are 2 solutions to reuse service of uptime at https://status.magickbase.com/

  1. Use OpenAPI of uptime https://uptime.com/api/v1/docs/, but it's limited to 500 requests/hour, and build the page by ourselves;
  2. Embed uptime's page in an iframe and update its style with custom CSS
    image

I would pick solution 2 because the page of uptime looks good to me.
Any idea from @WhiteMinds

@WhiteMinds
Copy link

Mentioning the Service Monitor -> Status status and Service Monitor -> History Incidents

There are 2 solutions to reuse service of uptime at https://status.magickbase.com/

  1. Use OpenAPI of uptime https://uptime.com/api/v1/docs/, but it's limited to 500 requests/hour, and build the page by ourselves;
  2. Embed uptime's page in an iframe and update its style with custom CSS
    image

I would pick solution 2 because the page of uptime looks good to me. Any idea from @WhiteMinds

I think I missed this message before.

I also agree with using Solution 2, to avoid reimplementing the uptime functionality again.

@Danie0918 Danie0918 requested review from Daryl-L, zhangyouxin and PainterPuppets and removed request for Sven-TBD, Daryl-L and zhangyouxin September 6, 2023 09:35
@PainterPuppets
Copy link

PainterPuppets commented Oct 12, 2023

After discussing with @WhiteMinds , it was decided to rename neuron-troubleshooting repo and change to monorepo, with each sub-project page as a separate package

@PainterPuppets
Copy link

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: 📫Hold On
Development

Successfully merging this pull request may close these issues.

4 participants