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

Link README.md to the index page on the website #906

Merged
merged 3 commits into from
Apr 7, 2025

Conversation

slimreaper35
Copy link
Member

Maintainers will complete the following section

  • Commit messages are descriptive enough
  • Code coverage from testing does not decrease and new code is covered
  • Docs updated (if applicable)
  • Docs links in the code are still valid (if docs were updated)

Note: if the contribution is external (not from an organization member), the CI
pipeline will not run automatically. After verifying that the CI is safe to run:

@slimreaper35 slimreaper35 linked an issue Apr 3, 2025 that may be closed by this pull request
Drop informal 'cough' annotation from documentation link to maintain
professional tone in project documentation.

Replace setup.py reference with more appropiate `pip download` example for
arbitrary code execution. Add footnote syntax instead.

Signed-off-by: Michal Šoltis <msoltis@redhat.com>
Replace docs index with symlink to README to avoid content duplication and
maintain a single source of truth.

Update documentation links to use full GitHub URLs when viewing outside
the repository context.

Signed-off-by: Michal Šoltis <msoltis@redhat.com>
1)
Enable navigation sections to organize content hierarchically, improving
site structure and user navigation experience.

From unexpanded list:

```
Package managers >
```

To sections:

```
Package managers
----------------

bundler
cargo
gomod
...
```

Minor improvement but it makes the sidebar more full.

2,3)
Activate search sharing and suggestions to increase discoverability and
streamline content access for end users.

Signed-off-by: Michal Šoltis <msoltis@redhat.com>
@slimreaper35 slimreaper35 added this pull request to the merge queue Apr 7, 2025
Merged via the queue into hermetoproject:main with commit 5e8cced Apr 7, 2025
15 checks passed
@slimreaper35 slimreaper35 deleted the website branch April 7, 2025 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Improve index page on our website
3 participants