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

Change default page in docs to installation #182

Closed
tylerbarna opened this issue Jul 28, 2023 · 5 comments
Closed

Change default page in docs to installation #182

tylerbarna opened this issue Jul 28, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@tylerbarna
Copy link
Collaborator

Feature Summary
change the default page from the quickstart to the installation instructions

Alternative Solutions
Have the default page be a basic welcome page with a button to proceed to installation

Additional context
This should also accompany an update to the structure of the installation docs, perhaps by making the installation issues a seperate page

@tylerbarna tylerbarna added the documentation Improvements or additions to documentation label Jul 28, 2023
@sahiljhawar
Copy link
Member

sahiljhawar commented Jul 28, 2023

master_doc = "index"

This should be changed to installation?

@tylerbarna
Copy link
Collaborator Author

This should be changed to installation?

either that or we just have a basic intro page (essentially the same content as the readme for the repo) as the index with a button at the bottom to proceed to the installation; for a new user, there should probably be a linear experience for: (1) navigating to the docs from the repo (2) being told how to install nmma and (3) running the quickstart commands to validate nmma has been installed correctly

@sahiljhawar
Copy link
Member

Maybe someone who knows web dev can create a default landing page. I tried to change the default page in the #185 but it didn't work that way.

This was referenced Aug 5, 2023
@mcoughlin
Copy link
Member

@sahiljhawar @tylerbarna Is this now resolved?

@sahiljhawar
Copy link
Member

sahiljhawar commented Aug 7, 2023

Yes. Documentation homepage is now installation guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants