diff --git a/docs/src/how-do-we-build-an-index.md b/docs/src/how-do-we-build-an-index.md index ff4cf022..3a81814f 100644 --- a/docs/src/how-do-we-build-an-index.md +++ b/docs/src/how-do-we-build-an-index.md @@ -3,58 +3,58 @@ layout: two-columns title: How do we build a DocSearch index? --- -In this section you will learn how do we build a DocSearch index from your page. +In this section you will learn how we build a DocSearch index from your page. -### Everything start from your page +### Everything starts from your page 1st step -_Note: We would rather avoid useless js rendering. Every used information should -be avaible without any client-side rendering. You can use `curl` in order to -have a better idea of how does it look._ +_Note: We would rather avoid useless js rendering. All useful information should +be available without any client-side rendering. You can use `curl` in order to +have a better idea of how it would look without any client-side rendering._ ### We extract the payload thanks to your set of `selectors` 2nd step -We will focus on the information highlted via your selectors. +We will focus on the highlighted information depending on your selectors. ### We iterate though the HTML flow and build the payload 3rd step -This payload will be the only considered data from your page. +This payload will be the only data extracted from your page. -### We iterate though the payload and start pushing record +### We iterate though the payload and start pushing records 4th step -We index the temporary record at every time we add an element int it (if -`min_indexed_level` is set to `0` ) +We index the temporary record when we add an element to it (if +`min_indexed_level` is set to `0`) -### We pile them up based on the current temporary record +### We pile up the elements based on the current temporary record 5th step -Base on the position withitn the flow, we nest elements as much as possble to +Base on the position within the flow, we nest elements as much as possble to keep the contextual relevancy. ### We iterate until we match a `text` element 6th step -### We override text element when we find a newer one +### We override the text element when we find a newer one 7th step -### We flush deeper element than the newest one +### We remove the stashed, deeper elements when we add a higher level 7th step -Contextual information and hierarchy must be updated once we encouter a new -level since it highlights a new sub section not related to the previous one. +Contextual information and hierarchy must be updated once we encounter a new +level since it highlights a new sub-section not related to the previous one. -If you need any further onformation, please [do not hesitate and send us your +If you need any further information, please [do not hesitate, send us your feedback][1]. [1]: mailto:docsearch@algolia.com