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

docs: refactor overview and start pages #2630

Merged

Conversation

reubenmiller
Copy link
Contributor

Proposed changes

Refactor the overview and start pages to reduce maintain by linking to other parts of the docs rather than listing individual pages within each section.

In addition the following minor tweak were made to improve the links within the pages:

  • Use fixed anchor ids
  • Use thin-edge.io name placeholder

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

#2628

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

* Use fixed anchor ids
* Use thin-edge.io name placeholder
* Only reference concepts section rather than listing individual pages

Signed-off-by: Reuben Miller <[email protected]>
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

docs/src/overview.md Show resolved Hide resolved
Copy link
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
383 0 3 383 100 1h0m33.800999999s

@reubenmiller reubenmiller added this pull request to the merge queue Jan 30, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 30, 2024
@reubenmiller reubenmiller added this pull request to the merge queue Jan 30, 2024
Merged via the queue into thin-edge:main with commit 947d999 Jan 30, 2024
18 checks passed
@reubenmiller reubenmiller deleted the docs-update-overview-start-pages branch July 18, 2024 13:29
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.

2 participants