Skip to content
D
Documentation

FAQ

reference
6 min readUpdated

What this FAQ covers

Conduit is a social blogging site for accounts, articles, comments, article lists, favorites, and following.

Choose an answer about a route or task, then open the page named in the table for its detailed procedure.

If you need to…Go to
Choose a feed, tag, or article listUnderstanding the interface
Sign inSign in
Create an accountSign up
Change account detailsManage your settings
Find or create an articleFind articles or Create and edit articles
Read or manage an articleRead and manage an article
Add a commentComment on articles
Work with profilesProfiles overview
Follow another userFollow other users
View favorite articlesView favorited articles
Understand a general errorGeneral error messages
Resolve a common issueCommon issues and solutions

Before you start

Prerequisites

Have or knowWhy it matters
The work you want to doThe application separates authentication, editing, articles, settings, and profiles into different routes.
Whether you are signed inHome uses a different article source when a token is present, and the header offers different links for signed-in and signed-out sessions.
The article slug when editing an existing articleThe editor uses the slug route for an existing article and the route without a slug for a new article.

Find the right route

A route is the address for the page where you perform a particular kind of work. The header provides links for Home, authentication, new articles, and settings.

Steps

  1. Choose the work you need to do.

    If you need to…Select or open
    Return to the article listsHome, or /
    Enter an existing accountSign in, or /login
    Create an accountSign up, or /register
    Create an articleNew Post, or /editor
    Change account detailsSettings, or /settings
    Open an existing articleRead and manage an article
    Open a profileView a profile
    Open a profile's favoritesView favorited articles

Result: You have selected the route for the work you want to do.

Sign in or create an account

Authentication lets you enter an existing account or create a new one. The sign-in form has Email and Password; the sign-up form has Username, Email, and Password.

Prerequisites

Use Sign in for an existing account and Sign up for a new account.

Steps

  1. Choose the account action.

    If you need to…Select
    Enter an existing accountSign in
    Create an accountSign up
  2. Enter the requested values in the fields shown on the selected page.

    PageFields
    Sign inEmail, Password
    Sign upUsername, Email, Password
  3. Select Sign in or Sign up on the selected page.

Result: The selected account form has been submitted.

Manage account settings

Account settings hold the profile picture URL, username, short biography, email address, and an optional new password.

Prerequisites

Open /settings from Settings when the signed-in account is available.

Steps

  1. Open /settings.

  2. Choose one account action.

    If you need to…Do this
    Save changed settingsEdit URL of profile picture, Username, Short bio about you, Email, or New Password, then select Update Settings.
    Log out without editing settingsSelect Or click here to logout.

Result: The selected alternative is complete: the settings update was submitted, or the logout action was selected.

Create, read, and comment on articles

An article is a published piece of writing with a title, description, body, and tags. The article page displays the body as sanitized markdown and includes comments.

Prerequisites

Select New Post to create an article. On an article page, select Edit Article to edit an existing article.

Steps

  1. Select New Post to open a new-article form, or select Edit Article on an article page to open the existing article in the editor.

  2. Enter the article title in Article Title.

  3. Enter its short description in What's this article about?.

  4. Write the body in Write your article (in markdown).

  5. Enter a tag in Enter tags and press Enter to add it to the tag list.

  6. Select Publish Article.

  7. Choose the article action you need.

    If you need to…Select
    Return to the editorEdit Article
    Delete your articleDelete Article
    Add a commentEnter text in Write a comment..., then select Post Comment

Result: The editor submission, article action, or comment submission has been selected.

Browse feeds and profiles

Home is the article-list starting point. It can show Global Feed, Your Feed when a token is present, a tag filter, and Popular Tags. Profiles show authored or favorited article lists.

Steps

  1. Open /.

  2. Choose the list or profile action you need.

    If you need to…Select or open
    Read the global article listGlobal Feed
    Read the signed-in feedYour Feed when it is available
    Filter by a tagA tag in Popular Tags
    View authored articlesMy Articles
    View favorited articlesFavorited Articles
    Follow or unfollow another userFollow or Unfollow
    Change your profile settingsEdit Profile Settings

Result: You have selected an article list, profile list, follow action, or settings route.

Understand errors and limits

The error list shows the API-provided key and value.

Steps

  1. Read the error text shown in the error list.
  2. Compare the displayed text with the action you just selected.
  3. For a general error message, open General error messages.
  4. For a setup or recurring issue, open Common issues and solutions.

Result: You have the API-provided error text and the page that owns the next remedy.

The error list uses this message format: key errors[key].

Continue with the task

Use the route or action you selected to continue:

Next taskPage
Learn the Home surfaceUnderstanding the interface
Navigate between routesNavigation basics
Sign inSign in
Sign upSign up
Manage settingsManage your settings
Work with articlesArticles overview
Find articlesFind articles
Create or edit articlesCreate and edit articles
Read an articleRead and manage an article
Favorite articlesFavorite articles
Comment on an articleComment on articles
View or follow profilesProfiles overview, View a profile, or Follow other users
View favorited articlesView favorited articles
Resolve an errorGeneral error messages or Common issues and solutions

Was this page helpful?

Download as PDF
FAQ — Conduit (React)