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

[website] Add documentation #403

Merged
merged 80 commits into from
Jun 27, 2023
Merged

Conversation

prichodko
Copy link
Collaborator

@prichodko prichodko commented May 16, 2023

Document components description

Here is a description of the document components in this document example.

Status ✅ Number Component name Component type Notes
-- Preview and Edit buttons The :material-file-eye: preview and :material-file-edit: edit buttons allow readers to preview the raw Markdown file in GitHub, or submit changes via pull requests.
[01] Header image image Describes the area on the UI where the action or discussion occurs.
[02] Topic title H1 header Each document has only one H1 header. This header appears in bold typeface at the top of the right-hand table of contents. Headers include an anchor link.
[03] Top area admonition admonition This is an optional admonition to alert readers about the feature availability. This admonition has no title.
[04] Internal link link A link to another document in Status Help or another H2 or H3 header in the same document.
[05] Paragraph text Paragraphs are limited to a maximum of 60 words.
[06] Sentence text Sentences are limited to a maximum of 25 words.
[07] Info admonition admonition There are three types of admonitions, in order of importance: tip, info, and caution.
[08] Section title H2 header Level-two headers group the different document sections. These headers appear in regular typeface in the right-hand table of contents. Headers include an anchor link.
[09] Code format code We use a code-format typeface for certain variables to distinguish them from the regular text. For example: Who holds, Is allowed to, or In.
[10] External link link A link to an external webiste. The link opens in a new tab and includes a trailing icon to inform readers is an external source.
[11] Bullet list list Bullet lists convery relevant topic information. Procedure-type documents use "What to expect" title, while concept-type documents use "The basics" title.
[12] Tabs tabs Tabs group information for a particular Status app platform o screen.
[13] Interactive UI elements UI label Inside procedural steps, elements the user can click or tap use an icon first (if any) and the label name in bold typeface.
[14] Second-level bullet lists list For steps with multiple options, options are grouped in second-level bullet lists. This element is rarely used and not recommended.
[15] Procedural steps numbered list Procedures with steps (not tasks) the user should complete in a particular order use numbered lists. The number of steps is limited to six or seven per procedure.
[16] Screenshot image Screeshosts guide users to the proper screen, and describe UI elements or UI interactions requiring multiple steps.
[17] Internal admonition admonition When using a tabbed interface, this admonition is visible only selecting one of the tabs. This helps to clarify information for a particular tab only.
[18] Tip admonition admonition There are three types of admonitions, in order of importance: tip, info, and caution.
[19] Substeps H3 header For procedural steps with more than 6-7 steps, we split the procedure into subprocedures. H3 is the minimum header level on our docs. Level-three headers don't appear in the right-hand table of contents. Headers include an anchor link.
[20] Procedural steps in a table numbered list Some proceral steps go inside tables. :material-triangle:
[21] Table table Any topic (procedure, concept, or reference) can include a table to summarize different information.
[22] Legend text A short legend explaining the numbers or figures on the table.
[23] Internal link A link to antoher part of the same document. Procedural steps may include internal links but never include external links.
[24] Admonition admonition In procedures, admonition go after the procedure or screenshot (if any).
[25] Tooltip tooltip A short description of a term that pops-up when the user taps (mobile) or hovers over the term (desktop).
[26] Checkboxes checkbox Procedures with more or less complex tasks (not steps) the user must complete, not necessarily in an orderly fashion.
[27] Caution admonition admonition There are three types of admonitions, in order of importance: tip, info, and caution.
[28] Common questions H2, H3 headers Some documents include this section at the end, with each question in a different H3 header.
-- Date, Authors information metadata Articles include the date of last update, or creation date if there is no update. Additionally, articles include the GitHub avatar of up to three different authors. Clicking on the author avatar opens their GitHub profile page.
-- Like, Dislike button buttons Provides users a way to send feedback about the document.

:material-triangle: Procedural steps inside tables should have the same format as procedural steps outside tables. At this time, we haven't updated the static site generator to achieve this functionality.

@vercel
Copy link

vercel bot commented May 16, 2023

@prichodko is attempting to deploy a commit to the Status Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link

vercel bot commented May 16, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
status-components 🔄 Building (Inspect) Mar 19, 2024 1:46pm
status-web 🔄 Building (Inspect) Mar 19, 2024 1:46pm
status-web-website ❌ Failed (Inspect) Mar 19, 2024 1:46pm
status-website ❌ Failed (Inspect) Mar 19, 2024 1:46pm

@prichodko prichodko force-pushed the website/docs branch 2 times, most recently from 9f50e0c to eed27e5 Compare May 19, 2023 13:40
@prichodko prichodko changed the title Add website documentation [website] Add documentation May 29, 2023
Copy link
Collaborator

@felicio felicio Jun 23, 2023

Choose a reason for hiding this comment

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

Missing in nav:

  • apps/website/docs/status-communities/about-tokens-collectibles-and-ens-names.md
  • apps/website/docs/status-communities/change-the-channel-access-type.md
  • apps/website/docs/status-communities/common-issues-when-the-community-s-control-node-is-offline.md
  • apps/website/docs/status-communities/configure-your-community-permissions.md
  • apps/website/docs/status-communities/create-a-token-gated-channel.md
  • apps/website/docs/status-communities/how-to-run-a-community-your-quick-start-guide.md
  • apps/website/docs/status-communities/how-to-use-communities-your-quick-start-guide.md
  • apps/website/docs/status-communities/join-a-status-community.md
  • apps/website/docs/status-communities/leave-a-channel.md
  • apps/website/docs/status-communities/leave-a-status-community.md
  • apps/website/docs/status-communities/permissions-by-role-in-status-communities.md
  • apps/website/docs/status-communities/self-destruct-a-token-remotely.md
  • apps/website/docs/status-communities/set-up-a-view-only-channel.md

Misc.:

  • apps/website/docs/status-communities/how-to-run-a-community-your-quick-start-guide.md (colon; more pages like that)
  • apps/website/docs/status-communities/index.md (not found)
  • apps/website/docs/status-communities/import-a-discord-community-into-status.md (doesn't have wip info)
  • apps/website/docs/status-communities/create-a-status-community.md (used <p style="text-align: center;">[)
  • use <br/> instead of </br> (e.g. in tables)
  • uppercase or lowercase "en" in "language: en"
  • use `{/* image */}` comments instead of <!--...-->

@prichodko prichodko requested a review from felicio June 23, 2023 20:41
Copy link
Collaborator

@felicio felicio left a comment

Choose a reason for hiding this comment

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

lgtm

@prichodko
Copy link
Collaborator Author

migration notes

  • Remove urls
--8&lt;-- "includes/urls-en.txt"
--8&lt;-- "includes/urls-en.txt"
  • Remove hide navigation
  • missing from navigation
    • add-a-new-device-to-your-status-profile
    • layer-2-scaling-solutions-for-ethereum
    • send-and-read-messages
    • share-a-group-chat
    • uninstall-status-desktop
    • about-status-communities
    • about-snt
    • about-your-wallet-accounts-and-addresses
    • add-watch-only-accounts
    • assets-your-quick-start-guide
    • buy-crypto
    • cancel-transactions
  • add-a-new-device-to-your-status-profile
  • layer-2-scaling-solutions-for-ethereum
  • send-and-read-messages
  • share-a-group-chat
  • uninstall-status-desktop
  • about-status-communities
  • about-snt
  • about-your-wallet-accounts-and-addresses
  • add-watch-only-accounts
  • assets-your-quick-start-guide
  • buy-crypto
  • cancel-transactions
  • Duplicates
    • your-status-notification-guide and your-status-notifications-guide
    • set-up-and-customize-notification-exceptions and set-your-notification-exceptions
    • set-notification-exceptions and set-your-notification-exceptions
    • Add a contact in Status in getting-started and profile
  • your-status-notification-guide and your-status-notifications-guide
  • set-up-and-customize-notification-exceptions and set-your-notification-exceptions
  • set-notification-exceptions and set-your-notification-exceptions
  • Add a contact in Status in getting-started and profile
  • create-or-restore-your-status-profile-using-a-recovery-phrase fix o to 0
  • remove manually written heading IDs
{: #create-or-restore-profile-with-recovery-phrase }
  • every heading ID is automatically generated
{: #create-or-restore-profile-with-recovery-phrase }
  • every heading ID is automatically generated
  • remove
 {:target="_blank"}
  • all external links are opened in a new tab
 {:target="_blank"}
  • all external links are opened in a new tab
  • remove comments
&lt;!--
## Update Status
--&gt;
&lt;!--
## Update Status
--&gt;
  • incorrectly closed
  • configure-mentions-and-all-other-messages
  • reset-your-notification-settings in navigation config does not exist
    • configure-mentions-and-all-other-messages
  • stay-anonymous-when-your-messages-are-forwarded has a title from different page
&lt;span class="screenreader" role="note"&gt;This page contains extra information that can be helpful to you if you use a screen reader. &lt;/span&gt;
  • custom element in back-up-and-secure-your-recovery-phrase
&lt;span class="screenreader" role="note"&gt;This page contains extra information that can be helpful to you if you use a screen reader. &lt;/span&gt;
  • no content is handled automatically
:octicons-tools-24: In progress

!!! note ""
We're working on this content.
  • Remove
:octicons-tools-24: In progress

!!! note ""
We're working on this content.
  • enable-rich-link-previews-in-messages
  • mute-your-notifications
  • "Send direct messages **to your contact""Send direct messages to your contact"
  • Fix typo in navigation Send and audio messageSend an audio message
    • "Send direct messages **to your contact""Send direct messages to your contact"
    • mute-your-notifications
    • enable-rich-link-previews-in-messages
  • change revision 0 from number to string
  • use correct syntax for code snippets for highlighting

@prichodko prichodko merged commit b88f7e7 into status-im:main Jun 27, 2023
3 checks passed
@prichodko prichodko deleted the website/docs branch June 27, 2023 20:30
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