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

Rewrite Getting Started Guide #665

Merged
merged 3 commits into from
Dec 15, 2024
Merged

Conversation

alcarney
Copy link
Member

@alcarney alcarney commented Oct 16, 2023

There's still a way to go with this, but the result of this PR will be

  • A tutorial walking the user through first steps with using esbonio via the Esbonio VSCode extension
  • A series of how to guides on setting esbonio up for use in other editors.
  • In general (hopefully!) better alignment to the Diátaxis approach to documentation

Big thanks to @evildmp for helping with this during the sprints at PyCon UK this year


14 months later...

The pre-release version is finally in a place where I think it makes sense to actually write the getting started guide. I'm sure it will need some refinement but this should be a good first pass.

Closes #899

@alcarney alcarney force-pushed the get-started branch 2 times, most recently from 3819717 to 1a78025 Compare November 19, 2023 22:57
@alcarney alcarney changed the title Restructure documentation Rewrite Getting Started Guide Mar 14, 2024
@alcarney alcarney marked this pull request as ready for review December 15, 2024 20:12
@alcarney alcarney merged commit b793715 into swyddfa:develop Dec 15, 2024
13 checks passed
@alcarney alcarney deleted the get-started branch December 15, 2024 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Esbonio VS Code Reviewer's Guide
1 participant