GitBook - Public wiki

User guide for navigating and accessing the content in our public wiki.

Welcome to the Simpler Grants Wiki! GitBook is our primary tool for documentation and knowledge sharing within the Simpler Grants community. This guide will help you get started and make the most out of your wiki experience.

Key Concepts & Features

Content Hierarchy

• Page: A page (like this one!) with content that is often focused on a single topic

• Space: A collection of pages that can be published as a public-facing website. Spaces are the level at which the following things are configured, such as:

  • Publication Status: Whether or not pages are published as a public-facing website

  • Domain name: The prefix of the URL used to access the site e.g. docs.grants.gov

  • Branding: The color and the font used visible on the published version of the site

  • Edit Access: Whether live edits are allowed and who has access to view and edit content

  • Integrations: Integrations with tools like Google Analytics or GitHub

• Organization: A collection of spaces that belong to a single organizational account. Organizations are the level at which the following things are configured:

  • Licenses: Adding or removing members to our GitBook account

  • Billing: Managing the GitBook plan we're currently on and how we're paying for it

Content Blocks

Note: For a complete breakdown of all of the content supported by GitBook, please refer to the list of blocks in their documentation.

GitBook allows users to use "blocks" to represent content in different formats. We've listed some common types of blocks below:

Block Type	Description
Headings	Bolded text that divide the page into sections and provide a stable link to a given section
Paragraphs	Normal text that can be bolded or italicized or colored
Bulleted Lists	Text arranged in a list where each line is a new bullet
Numbered Lists	Text arranged in a list where each line is a new number
Table	Text arranged in columns and rows with an optional header
Cards	Items arranged in a grid that support multiple field types, cover images, and can redirect a user to a target link when clicked
Files	Links to content that have been uploaded to GitBook
Images	Embedded images that appear within the body of a page
Embedded URL	Embedded videos, forms, publicly accessible documents, etc.
Expandable	Sections on the page that can be expanded to reveal more content
Hint	Text with specific formatting that allows content editors to highlight notes, tips, or warnings for the reader

Integrations

Note: For an up-to-date list of all of the integrations supported by GitBook, please refer to the integrations page on their website.

GitBook functionality can be extended with a number of out of the box integrations. We've highlighted a few key integrations that we plan to use below:

Integration	Features
GitHub Sync	Bi-directionally syncs GitBook content with markdown files in a GitHub repository
Google Analytics	Track in-depth page analytics for published spaces
Figma	Embeds Figma art boards and files into GitBook pages
Slack	Search GitBook docs and save content to GitBook directly from Slack

Navigating the Workspace

The workspace is broken down into main sections with subtopics underneath. These can all be seen on the left side of the screen.

Topics	Details
About	This section includes information about team norms, people contributing and terminology used by our community.
Product	This section includes planning information about the product including the roadmap and any deliverables along the way. It also contains information about the product itself.
Collaborating	This includes policies including our code of conduct, as well as guides on how to use the different communication tools that we have available. Finally, it includes information on how to get involved.
Contributing	This contains information on how to participate in contributing code and other assets to the Simpler Grants project.

FAQs

I can't seem to edit the text on the page. How can make changes?

If you want to make changes to a page but can't edit the page contents by clicking into them, the page most likely has live edits locked. To edit the contents of a locked page, follow the instructions in this section on change requests

If you don't have the option to create a change request and you can't edit the page directly, reach out to a GitBook administrator to make sure you have the correct permissions within the space.

The tables on the page are too cramped. How can I fix that?

GitBook allows you to set tables to full-width which should provide you with more horizontal space to view the table.

If the table is already full-width and the information is still too cramped, hiding your sidebar on the left-hand side may help:

If your table is full-width and the sidebar is hidden and it still appears too cramped, you may want to consider spreading the contents across multiple tables or converting it into a set of cards.

Major updates to the content of this page will be added here.

Date	Update	Notes
2/12/2024	Initial Content	Updated with Initial content