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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Break README.md into document subpages? #119

Closed
lintool opened this issue May 20, 2020 · 3 comments · Fixed by #167
Closed

Break README.md into document subpages? #119

lintool opened this issue May 20, 2020 · 3 comments · Fixed by #167

Comments

@lintool
Copy link
Member

lintool commented May 20, 2020

Main README.md is getting pretty long. Should we break into separate pages?

  • Usage of the Analyzer API
  • Usage of the Query Builder API
  • ...

@chriskamphuis @PepijnBoers @x65han thoughts?
@lintool
Copy link
Member Author

lintool commented Jun 3, 2020

cf. #163 (comment)

@rodrigonogueira4 I assume you'd support this?

@rodrigonogueira4
Copy link
Member

Yes, sure

@chriskamphuis
Copy link
Collaborator

Sorry missed this earlier, I agree to split

This was referenced Jun 3, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Refactoring docs to break into subpages castorini/pyserini
3 participants
@lintool @rodrigonogueira4 @chriskamphuis