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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting started doc segment #835

Open
1 task done
FasterSpeeding opened this issue Oct 8, 2021 · 4 comments
Open
1 task done

Getting started doc segment #835

FasterSpeeding opened this issue Oct 8, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@FasterSpeeding
Copy link
Collaborator

Summary

Add a getting started segment to the docs.

Problem

API references are a lot to take in and go over for someone who's just getting used to the library and a getting started segment can help ease people into it.

Ideal implementation

a getting started segment to the docs or at least on the docs site.

Checklist

  • I have searched the issue tracker and have made sure it's not a duplicate.
    If it is a follow up of another issue, I have specified it.
@FasterSpeeding FasterSpeeding added enhancement New feature or request documentation Improvements or additions to documentation labels Oct 8, 2021
@davfsa
Copy link
Member

davfsa commented Oct 8, 2021

Probably also good to leave this here, along with the migration that is being worked on in #760, I wanted to setup a neat design that we can later integrate with jekyll (what github pages uses, not my choice) to parse .md files to static pages. This will allow us to add more sections without worrying about all the HTML

This involves making the theme for #808 work nicely with jekyll

@FasterSpeeding
Copy link
Collaborator Author

This could possibly also be a resolution for #815 since we could link to tanjun and lightbulb for slash commands in the actual documentation

@davfsa
Copy link
Member

davfsa commented Nov 9, 2021

Just to add an idea, we could maybe make use of mdBook to do this instead of making a jekyll theme, which is going to be arguably harder.

This would include some planning, but a "hikari book" might be ideal for this. There we could include different sections for different things

@PythonTryHard
Copy link
Contributor

Related PR: #1522

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants