Skip to content

Draft: Claude starter page

Suzanne Selhornrequested to merge
selhorn-testing123 into master

What does this MR do?

From this Claude conversation: https://claude.ai/share/88875ad9-2c85-4eb5-ab41-a728cd0c353c

Update:

  • I'm going in two directions. 1) a top-level landing page and onboaring pages and 2) merge requests, helping people ease in.

So I have it, here is the MR nav it's proposing.

          - doc_title: Merge requests
            doc_url: 'ee/user/project/merge_requests/landing.html'
            docs:
              - doc_title: Beginner's Guide
                doc_url: 'ee/user/project/merge_requests/beginner.html'
              - doc_title: Intermediate Guide
                doc_url: 'ee/user/project/merge_requests/intermediate.html'
              - doc_title: Advanced Guide
                doc_url: 'ee/user/project/merge_requests/advanced.html'
              - doc_title: Create a Merge Request
                doc_url: 'ee/user/project/merge_requests/creating_merge_requests.html'
                docs:
                  - doc_title: Draft Merge Requests
                    doc_url: 'ee/user/project/merge_requests/drafts.html'
                  - doc_title: Merge Request Dependencies
                    doc_url: 'ee/user/project/merge_requests/dependencies.html'
                  - doc_title: Confidential Merge Requests
                    doc_url: 'ee/user/project/merge_requests/confidential.html'
              - doc_title: Review and Collaborate
                doc_url: 'ee/user/project/merge_requests/reviews/'
                docs:
                  - doc_title: The Merge Request Interface
                    doc_url: 'ee/user/project/merge_requests/widgets.html'
                  - doc_title: Review Changes
                    doc_url: 'ee/user/project/merge_requests/changes.html'
                  - doc_title: Make Suggestions
                    doc_url: 'ee/user/project/merge_requests/reviews/suggestions.html'
                  - doc_title: Track Versions
                    doc_url: 'ee/user/project/merge_requests/versions.html'
                  - doc_title: Use GitLab Duo
                    doc_url: 'ee/user/project/merge_requests/duo_in_merge_requests.html'
                  - doc_title: Work Across Forks
                    doc_url: 'ee/user/project/merge_requests/allow_collaboration.html'
              - doc_title: Commits and Changes
                doc_url: 'ee/user/project/merge_requests/commits.html'
                docs:
                  - doc_title: Commit Templates
                    doc_url: 'ee/user/project/merge_requests/commit_templates.html'
                  - doc_title: Cherry-pick Changes
                    doc_url: 'ee/user/project/merge_requests/cherry_pick_changes.html'
                  - doc_title: Revert Changes
                    doc_url: 'ee/user/project/merge_requests/revert_changes.html'
                  - doc_title: Stacked Diffs
                    doc_url: 'ee/user/project/merge_requests/stacked_diffs.html'
              - doc_title: Approvals and Merging
                doc_url: 'ee/user/project/merge_requests/approvals/'
                docs:
                  - doc_title: Approval Rules
                    doc_url: 'ee/user/project/merge_requests/approvals/rules.html'
                  - doc_title: Approval Settings
                    doc_url: 'ee/user/project/merge_requests/approvals/settings.html'
                  - doc_title: Merge Methods
                    doc_url: 'ee/user/project/merge_requests/methods/'
                  - doc_title: Auto-merge
                    doc_url: 'ee/user/project/merge_requests/auto_merge.html'
                  - doc_title: Squash and Merge
                    doc_url: 'ee/user/project/merge_requests/squash_and_merge.html'
                  - doc_title: Resolve Conflicts
                    doc_url: 'ee/user/project/merge_requests/conflicts.html'
              - doc_title: Administration
                doc_url: 'ee/user/project/merge_requests/manage.html'
                docs:
                  - doc_title: Status Checks
                    doc_url: 'ee/user/project/merge_requests/status_checks.html'
                  - doc_title: Export to CSV
                    doc_url: 'ee/user/project/merge_requests/csv_export.html'
                  - doc_title: Troubleshooting
                    doc_url: 'ee/user/project/merge_requests/merge_request_troubleshooting.html'

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Suzanne Selhorn

Merge request reports