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

Rework the docs for v1 #209

Open
blaggacao opened this issue Dec 22, 2022 · 3 comments
Open

Rework the docs for v1 #209

blaggacao opened this issue Dec 22, 2022 · 3 comments
Labels
🔥 Priority: High This issue is prioritized as high 💪 Effort: 3 This issue is of medium complexity or only partly well understood 📜 Type: Story This issue targets a new feature through a story
Milestone
Release v1

Comments

@blaggacao
Copy link
Collaborator

blaggacao commented Dec 22, 2022 •
edited

The docs have been co-evolving with the project

But they have never been properly designed for particular target audiences, despite somewhat trying to make use of the documentation framework.
@blaggacao blaggacao added this to the Release v1 milestone Dec 22, 2022
@blaggacao blaggacao added 📜 Type: Story This issue targets a new feature through a story 🔥 Priority: High This issue is prioritized as high 💪 Effort: 3 This issue is of medium complexity or only partly well understood labels Dec 22, 2022
@blaggacao
Copy link
Collaborator Author

Include Architectural overview of the components & flakes involved

@blaggacao blaggacao mentioned this issue Jan 5, 2023
Open
@jorsn
Copy link

jorsn commented Jan 23, 2023

And please define/avoid abbreviations. I had to look up SDLC in the readme, since I'm not an SD ;) Thanks!

@blaggacao
Copy link
Collaborator Author

And please define/avoid abbreviations.

Good point: 42db376

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🔥 Priority: High This issue is prioritized as high 💪 Effort: 3 This issue is of medium complexity or only partly well understood 📜 Type: Story This issue targets a new feature through a story
Projects
None yet
Milestone
Release v1
Development

No branches or pull requests
2 participants
@jorsn @blaggacao