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

Add documentation as a static site on GitHub pages #12

Open
12 of 20 tasks
bdsoha opened this issue Nov 30, 2022 · 0 comments
Open
12 of 20 tasks

Add documentation as a static site on GitHub pages #12

bdsoha opened this issue Nov 30, 2022 · 0 comments
Labels
📚 documentation Improvements or additions to documentation ✨ enhancement New feature or request
Milestone
🏗️ v1.0.0 - Core ...

Comments

@bdsoha
Copy link
Owner

bdsoha commented Nov 30, 2022 •
edited

Add documentation as a static site on GitHub pages.

  • Add CI deployment to GitHub pages
  • Add a custom CNAME record
  • Create docs directory with .md files and VitePress
  • Refactor the main readme to point the documentation site
  • Remove the PYPIREADME.md
  • Contributing guidelines #69

Pages

  • Introduction / What is Expycted?
  • Introduction / Installation
  • Introduction / Getting Started
  • Expectations / Overview + Available Expectations
  • Expectations / Strict Mode
  • Expectations / Higher Order Tests
  • Expectations / Interface / Main
  • Expectations / Interface / Chains
  • Expectations / Interface / Filesystem
  • Expectations / Interface / Functions
  • Get Involved / Introduction (issues/bugs/docs)
  • Get Involved / Development Install
  • Get Involved / Contribution Workflow
  • Get Involved / Pull Request Guidelines
@bdsoha bdsoha mentioned this issue Nov 30, 2022
Closed
5 tasks
@bdsoha bdsoha added this to the 🏗️ v1.0.0 - Core Rewrite milestone Dec 8, 2022
Repository owner deleted a comment from petereon Dec 8, 2022
Repository owner deleted a comment from petereon Dec 8, 2022
@bdsoha bdsoha added 📚 documentation Improvements or additions to documentation ✨ enhancement New feature or request labels Dec 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📚 documentation Improvements or additions to documentation ✨ enhancement New feature or request
Projects
None yet
Milestone
🏗️ v1.0.0 - Core Rewrite
Development

When branches are created from issues, their pull requests are automatically linked.

feature/docs bdsoha/expycted
1 participant
@bdsoha