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

Adding docs for website's doc service #12

Open
14 tasks
Tracked by #20
ManiMozaffar opened this issue Jul 5, 2023 · 0 comments · May be fixed by #30
Open
14 tasks
Tracked by #20

Adding docs for website's doc service #12

ManiMozaffar opened this issue Jul 5, 2023 · 0 comments · May be fixed by #30
Assignees
@Cmatrix1
Labels
documentation Improvements or additions to documentation

Comments

@ManiMozaffar
Copy link
Member

ManiMozaffar commented Jul 5, 2023 •
edited
Loading

  • We should consider starting to add docs, for the project, so that user can understand layout better. We shouldn't take this into last step, I believe that docs should be started to be written, and discussed on how we're showcasing our product.
  • Complete wiki

The docs should contains these pages:

Beginner guide:

  • Setting up Project
  • Spider and Process with Saving data
  • Selectors
  • Engine
  • Task scheduler
  • Logging
  • DIP in fastcrawler
  • Testing

Advanced guide

  • Customizing Engine
  • Customizing Logging
  • Customizing Parser
  • Middleware
@ManiMozaffar ManiMozaffar added the documentation Improvements or additions to documentation label Jul 5, 2023
@ManiMozaffar ManiMozaffar mentioned this issue Jul 5, 2023
Open
31 tasks
@ManiMozaffar ManiMozaffar changed the title Adding docs for third website Adding docs for website's doc service Jul 5, 2023
@Cmatrix1 Cmatrix1 self-assigned this Jul 14, 2023
@ManiMozaffar ManiMozaffar linked a pull request Jul 15, 2023 that will close this issue
WIP: Add Persian and English mkdocs #30
Draft
@ManiMozaffar ManiMozaffar assigned Cmatrix1 and unassigned Cmatrix1 Jul 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Cmatrix1 Cmatrix1

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

WIP: Add Persian and English mkdocs fast-crawler/fastcrawler
2 participants
@Cmatrix1 @ManiMozaffar