Skip to content

docs/revamp documentation and automate screenshots#343

Merged
edouard-lopez merged 12 commits intomasterfrom
docs/automate-screenshots-for-documentation
Jan 25, 2024
Merged

docs/revamp documentation and automate screenshots#343
edouard-lopez merged 12 commits intomasterfrom
docs/automate-screenshots-for-documentation

Conversation

@edouard-lopez
Copy link
Member

@edouard-lopez edouard-lopez commented Jan 20, 2024

related: #339
It's a live doc 🧟

Goal

  • a better User eXperience (UX)
  • a dedicated site,
  • searchable content (thanks to mkdocs)
  • screenshot of prompt with/without feature enabled (thanks to terminal-screenshot)
  • a better organization for options
  • linkable content you can share/bookmark

Todo

It's a work in progress, so new thing could come up.

  • docs: basic mkdocs workflow
  • docs: continue migration
  • ci: publish documentation to gh-pages
  • docs: improve ux
  • docs: revamp README to redirect towards mkdocs
  • docs(screenshots):
    • setup docker,
    • makefile tasks
    • explore automate screenshot
    • refactor (migrate screenshot script to docs/ directory?)
  • Start collecting community feedback and expectations to drive follow up MRs

Check it out: https://pure-fish.github.io/pure/

@edouard-lopez edouard-lopez mentioned this pull request Jan 20, 2024
14 tasks
@edouard-lopez edouard-lopez changed the title docs/automate screenshots for documentation docs/revamp documentation and automate screenshots Jan 22, 2024
@edouard-lopez edouard-lopez marked this pull request as draft January 22, 2024 10:36
@edouard-lopez edouard-lopez added 🚀 enhancement performance, UX or maintainability ⭐️ idea feature request or suggestion labels Jan 22, 2024
@edouard-lopez edouard-lopez force-pushed the docs/automate-screenshots-for-documentation branch from c1a6fd5 to f954f26 Compare January 23, 2024 11:14
@edouard-lopez
Copy link
Member Author

I will continue the screenshot part in another PR

@edouard-lopez edouard-lopez marked this pull request as ready for review January 25, 2024 14:35
@edouard-lopez edouard-lopez force-pushed the docs/automate-screenshots-for-documentation branch from 016f5e7 to 8b9c1b8 Compare January 25, 2024 22:05
@edouard-lopez edouard-lopez merged commit 536ce3a into master Jan 25, 2024
@edouard-lopez edouard-lopez deleted the docs/automate-screenshots-for-documentation branch January 25, 2024 22:08
@edouard-lopez edouard-lopez mentioned this pull request Jan 26, 2024
5 tasks
@jorgebucaran
Copy link
Contributor

🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🚀 enhancement performance, UX or maintainability ⭐️ idea feature request or suggestion

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants