Improve integration summaries
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start by reviewing the existing integration pages and the Vale rules and definitions mentioned in the issue. Compare their tone, structure, assumptions, and practical detail, then make each page consistently explain the integration and its benefits; done means the pages follow a shared approach without assuming prior knowledge.
Written by the indexing model from the issue text.
Description
The integration pages serve 2 purposes:
- Inform users what and how the integration works
- Sell the benefits of the inregration to potential new users reviewing the docs to see how it works.
Make each integration page:
- Use consistent style, tone, and language ( in addition to complying with all the Vale rules and definitions)
- Have a structiured approach to each page that begins by making no assumptions of what the integrations and what mission control is (besides for the main overview page) as you scroll down it becomes more practical
- Dominant language
- CSS
- Stars
- 1
- Forks
- 2
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 2
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from flanksource/docs
-
bugathon
Difficulty 1/5 Under an hour Newbie friendliness 72/100
flanksource/docs#34 ·
-
bugathon
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
flanksource/docs#32 ·
-
bugathon
Difficulty 1/5 Under an hour Newbie friendliness 62/100
flanksource/docs#17 ·
-
Postgres PermissionsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 38/100
flanksource/docs#506 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
flanksource/docs#466 · 1 comment ·
All issues in flanksource/docs
Similar issues
-
Docs: "Work with Codex from anywhere" page still claims Windows mobile support is "coming soon"Openapp documentation remote windows-os
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
librepods-org/librepods#802 ·
Maintainers usually reply within 1 day
-
area:lint-tooling found-by:critic kind:docs-drift
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
InauguralSystems/EigenScript#1335 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
Maintainers usually reply within 1 day
-
technical-improvement
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 4 days