Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify steps to add custom lunr index code #1139

Merged
merged 2 commits into from
Jan 23, 2023

Conversation

diablodale
Copy link
Contributor

Follow-up doc updates from PR #1068
Merges several conversations from that PR and simplifies some language

Open to feedback 馃憤

Copy link
Member

@mattxwang mattxwang left a comment

Choose a reason for hiding this comment

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

Minor nit: can we keep the newline format of this file (i.e., not adding a newline when you hit ~ 80 characters)? It makes future git diffs not very helpful.

(down the line, I'll add some prettier automation to make this work)

I don't have any other major comments on the documentation right now, but I'll come back to it when I have more time (~ a day or so).

@diablodale
Copy link
Contributor Author

Ill push update with single lines for everything. I'm not sure that's what you want so tell me when you see the commit.
FYI: all git tools can ignore whitespace with diffs; in github it is under the gear icon then choose ignore whitespace.

@mattxwang
Copy link
Member

FYI: all git tools can ignore whitespace with diffs; in github it is under the gear icon then choose ignore whitespace.

Yup - I meant more, when we have another person commit and swap them back, etc. it introduces noise in the commit graph. Thanks for being so quick on this!

Copy link
Member

@mattxwang mattxwang left a comment

Choose a reason for hiding this comment

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

Gave it a more thorough look, this seems good to merge to me!

@diablodale any last comments before we merge? I'll try to not repeat my same mistake from last time.

@mattxwang mattxwang changed the title update docs: Custom content for lunr search index docs: clarify steps to add custom lunr index code Jan 23, 2023
@mattxwang mattxwang mentioned this pull request Jan 23, 2023
8 tasks
@diablodale
Copy link
Contributor Author

@diablodale any last comments before we merge? I'll try to not repeat my same mistake from last time.

LGTM

@mattxwang mattxwang merged commit c7bdfe5 into just-the-docs:main Jan 23, 2023
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.

None yet

2 participants