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

Docs and book #4

Open
Defman opened this issue Mar 10, 2021 · 0 comments
Open

Docs and book #4

Defman opened this issue Mar 10, 2021 · 0 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Defman
Copy link
Member

Defman commented Mar 10, 2021

Book

The docs navigation link should display the pages from feather-rs/feather/docs/src.

API

  1. The SUMMARY.md should be parsed and returned on api/docs/summary
  2. Each page from in the src should be built and served through api/docs/page/[...src_path]
  3. The built pages should be cached and a build should be triggered via webhooks.

Useful dependencies

Frontend

  1. The result of api/docs/summary should be displayed in the aside on frontend/docs/*
  2. The content of every page should be loaded from the api api/docs/page/[...src_path] displayed on frontend/docs/[...src_path].
  3. On frontend/docs the first chapter from api/docs/summary should be displayed.
@Defman Defman added good first issue Good for newcomers help wanted Extra attention is needed labels Mar 10, 2021
@Defman Defman self-assigned this Mar 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant