Getting Started

This tutorial will get you comfortable with the basics of WOPR, by walking you through adding it to an existing react website containing technical documentation. If you're starting from scratch, we recommend following the guides by ContentLayer or Next.js to create a basic markdown-based website.

As an alternative to reading this tutorial, you can also follow along to a guided video walkthrough by one of our founders, where he goes through how he setup WOPR for the WOPR website itself.

Click here to see a video walkthrough of installing WOPR on WOPR!

Background: What is WOPR?

WOPR is a toolkit for individuals and startups alike to make their technical documentation "come alive", i.e., be interactive and engaging to end-users. To do this, we do the following:

  • Index markdown content from one or more Github repositories, periodically or whenever new content is added.
  • Expose AI-powered search functionality via a CMD+K menu. This means users can ask questions as if they were chatting to a real person. Furthermore, the user doesn't need to know specific, possibly domain-specific keywords to get answers.
  • Give the website owner the tools to understand how users are interacting with their documentation, for the purpose of improving and patching up holes in the documentation.

Step 1: Login + Create a Team

Login to WOPR by entering your email address. After doing so, you'll get an email to verify that you in fact own the email address you entered. If an account doesn't exist, it'll be created automatically.

Once logged in, you'll be prompted to choose a slug for your team. A slug is a globally unique, and is used to identify your team. As of now, teams are limited to a single member (the creator), though this will change in the near future when we add support for inviting other members to your team.

Step 2: Link your Github Account

The first time you login, you'll be asked to link your Github account and will be prompted to do so. Please make sure to give WOPR access to all the repositories which you'll be wanting to index.

Step 3: Create a Project

Each team can have one or more projects, and each project is meant to represent a single logical set of documentation. Again, you'll have to choose a slug for each new project you create, and this slug is unique to your team.

In the future, projects will be billed according to our pricing model. For now, they're free.

Step 4: Link a Github Repository

Each project can have one or more linked repositories, from which WOPR will fetch and index markdown content. To link a new repository, simply click the orange "Link repo" button at the top-right of the project overview page. You'll be asked to select/enter the following:

  • The repository which you'd like to link. A list of your repositories will be automatically fetched from your Github account.
  • The ref of the repository, i.e., which branch or tag you'd like to use.
  • (Optional) The root path to use within the repository, i.e., the path where you'd like WOPR to start its search from. This option is particularly useful for mono-repos.
  • (Optional) The root URL, i.e., the website URL where the documentation is hosted. This is used as a backup in case we're unable to automatically determine the URL of a given markdown file.

Note: Sometimes, markdown files are stored in tricky ways which don't map cleanly to web URLs. In this case, we recommend following the Linkmaps tutorial to configure the links properly.

Conclusion

At this point, you should be able to search over your documentation using the provided search interface on the overview page of a given project. Note: It may take a few minutes to index your content, so please be patient.

If you have any questions or feedback, please send us an email!