Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[Feature Request] Documentation #5009

Open
Assignees
Labels
Priority: LowIndicates that an issue or pull request should be resolved behind issues or pull requests labelled ` Status: Awaiting authorIndicates that an issue or pull request requires author action Status: ParkedIndicates that an issues or pull request will be revisited later
@Shubham-Rasal

Description

Feature Request

I think documentation should have it's own place rather than a directory in the github repo.

Describe the desired solution

The idea is to move the documentation on a separate website, with clear navigation.

Describe possible alternatives

I would suggest we use Mintify or similar for structuring the documentation.

Additional context

I have been working on a side project using firecracker and find it difficult to navigate the docs dir. Although being comprehensive, the docs lack cohesivity.

I am willing to take up this effort, as it is a long-term commitment and could easily take more than a few weeks to update fully.

Checks

  • Have you searched the Firecracker Issues database for similar requests?
  • Have you read all the existing relevant Firecracker documentation?
  • Have you read and understood Firecracker's core tenets?

Metadata

Metadata

Labels

Priority: LowIndicates that an issue or pull request should be resolved behind issues or pull requests labelled ` Status: Awaiting authorIndicates that an issue or pull request requires author action Status: ParkedIndicates that an issues or pull request will be revisited later

Type

No type

Projects

No projects

Milestone

No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      AltStyle によって変換されたページ (->オリジナル) /