Skip to content

Initial Umbraco Search docs#7905

Open
kjac wants to merge 13 commits intomainfrom
umbraco-search/initial-docs
Open

Initial Umbraco Search docs#7905
kjac wants to merge 13 commits intomainfrom
umbraco-search/initial-docs

Conversation

@kjac
Copy link
Copy Markdown
Contributor

@kjac kjac commented Mar 18, 2026

📋 Description

Docs for Umbraco Search:

  • All the existing docs from the current GitHub repo, rewritten for the docs portal.
  • Articles missing from the existing docs, particularly revolving around extensibility.

Once these docs become available on the docs portal, the existing docs will be replaced with a link to the docs portal.

📎 Related Issues (if applicable)

N/A

✅ Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

  • Code blocks are correctly formatted.
  • Sentences are short and clear (preferably under 25 words).
  • Passive voice and first-person language (“we”, “I”) are avoided.
  • Relevant pages are linked.
  • All links work and point to the correct resources.
  • Screenshots or diagrams are included if useful.
  • Any code examples or instructions have been tested.
  • Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

N/A

Deadline (if relevant)

Whenever possibe.

📚 Helpful Resources

Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

17/umbraco-search/getting-started/examine-search-provider.md|19 col 28| [UmbracoDocs.Editorializing] Consider removing 'essentially' as it can be considered opinionated.
17/umbraco-search/getting-started/examine-search-provider.md|19 col 194| [UmbracoDocs.Spelling] Check the word 'releaseYear' for typos.
17/umbraco-search/getting-started/examine-search-provider.md|63 col 45| [UmbracoDocs.Editorializing] Consider removing 'various' as it can be considered opinionated.
17/umbraco-search/getting-started/examine-search-provider.md|87 col 91| [UmbracoDocs.Terms] Use 'for example' instead of 'e.g' for consistency.
17/umbraco-search/getting-started/examine-search-provider.md|88 col 98| [UmbracoDocs.Terms] Use 'for example' instead of 'e.g' for consistency.
17/umbraco-search/getting-started/examine-search-provider.md|89 col 97| [UmbracoDocs.Terms] Use 'for example' instead of 'e.g' for consistency.
17/umbraco-search/getting-started/examine-search-provider.md|95 col 156| [UmbracoDocs.Spelling] Check the word 'releaseYear' for typos.
17/umbraco-search/getting-started/examine-search-provider.md|97 col 1| [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.
17/umbraco-search/getting-started/examine-search-provider.md|99 col 1| [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.
17/umbraco-search/getting-started/examine-search-provider.md|112 col 1| [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.
17/umbraco-search/extending/backoffice-extensions.md|3 col 96| [UmbracoDocs.HeadingsPunctuation] Do not use '.' at the end of heading.
17/umbraco-search/extending/backoffice-extensions.md|17 col 50| [UmbracoDocs.Spelling] Check the word 'composable' for typos.
17/umbraco-search/extending/backoffice-extensions.md|123 col 5| [UmbracoDocs.Acronyms] 'NOTE' has no definition.
17/umbraco-search/extending/backoffice-extensions.md|124 col 82| [UmbracoDocs.Terms] Use 'documentation' instead of 'docs' for consistency.
17/umbraco-search/extending/backoffice-extensions.md|214 col 5| [UmbracoDocs.Acronyms] 'NOTE' has no definition.
17/umbraco-search/extending/backoffice-extensions.md|215 col 83| [UmbracoDocs.Terms] Use 'documentation' instead of 'docs' for consistency.
17/umbraco-search/extending/backoffice-extensions.md|445 col 77| [UmbracoDocs.Editorializing] Consider removing 'just' as it can be considered opinionated.
17/umbraco-search/extending/backoffice-extensions.md|447 col 5| [UmbracoDocs.Spelling] Check the word 'tsconfig' for typos.

@kjac kjac changed the title Ported existing docs Initial Umbraco Search docs Mar 18, 2026
@github-actions
Copy link
Copy Markdown

The Link Checker found broken links in your PR.
Please review the following list:

Broken links found in: 17/umbraco-search/extending/gathering-data-with-content-indexers.md

🗒️ File not found → - [ ] [ERROR] 17/umbraco-search/extending/database-cache-for-index-values.md | Cannot find file: File not found. Check if file exists and path is correct

Broken links found in: 17/umbraco-search/extending/index-values-for-property-editors.md

🗒️ File not found → - [ ] [ERROR] 17/umbraco-search/extending/database-cache-for-index-values.md | Cannot find file: File not found. Check if file exists and path is correct

@kjac kjac marked this pull request as ready for review April 8, 2026 06:29
@kjac
Copy link
Copy Markdown
Contributor Author

kjac commented Apr 8, 2026

There's a TODO in the root README file here. The idea is that it should be replaced with a cards view like the one on https://docs.umbraco.com/umbraco-cms

image

...however, I am not entirely sure how to add those cards 🙈

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants