How to Create a Project
Learn how to create a new project in the documentation workflow.
How to create a project
Create a project by choosing a source folder, linking the pages you want to publish, and confirming that the build or preview renders as expected.
Prerequisites
- You have access to the repository or workspace where the project will live.
- You have permission to add or update project content.
- The repository contains the source folder you want to use for the project.
Steps
Create the project
Start a new project in the documentation workflow used by your repository. Use the repository's existing naming and setup pattern, and adjust the wording to match the repo's UI if it differs from the labels described here.
Choose the documentation source folder
Select the folder that contains the content you want the project to publish. Use the folder that already holds the pages, guides, or reference files for that project.
Link the content pages
Connect the pages you want included in the project so they are available in the generated documentation structure. Verify that the pages you expect are part of the source set before continuing.
Confirm the build and preview
Run the build or preview process used by your documentation workflow, then check that the project loads without errors and that the expected content appears.
Verify it worked
A successful setup shows the project pages in the preview and the navigation for those pages in the published structure.
Success looks like this: the project pages render, the expected navigation entries appear, and the preview matches the content in your source folder.
Common mistakes
Check that the pages are inside the selected source folder and that the project includes them in its content set.
Repoint the project to the folder that contains the intended documentation files. If the wrong folder is selected, the preview usually shows incomplete or unrelated content.
Confirm that the linked pages are included in the project structure and that the navigation source picks up the new pages. If needed, update the repository's navigation source so it matches the content you added.