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

Add multiple page docs #31

Merged
merged 3 commits into from
Dec 5, 2024
Merged

Add multiple page docs #31

merged 3 commits into from
Dec 5, 2024

Conversation

ketankartoza
Copy link
Contributor

This Pr is for the issue #30

@ketankartoza ketankartoza added the documentation Improvements or additions to documentation label Dec 4, 2024
@ketankartoza ketankartoza self-assigned this Dec 4, 2024
Copy link
Contributor

@Jeremy-Prior Jeremy-Prior left a comment

Choose a reason for hiding this comment

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

Please adjust the image paths and make use of the video embedding.


This `About` section provides detailed information about the BIMS project. It offers insights into the project's objectives, purpose, and significance, helping users understand its scope and how it aims to address specific challenges.

[![Home Page](./img/about-img-1.png)](./img/about-img-1.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are all the images relative links in all the files?

Standard images in markdown would be: ![Image Name](path/to/image.png)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Jeremy-Prior, once Eli told me to do that to show the image content properly.

Copy link
Contributor

@Jeremy-Prior Jeremy-Prior Dec 5, 2024

Choose a reason for hiding this comment

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

@ketankartoza I'm going to need more of an explanation than that. Making images into links will not affect how the image displays on the site?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Jeremy-Prior, when we click on the image it will open that image in a new window in bigger size.

Copy link
Contributor

Choose a reason for hiding this comment

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

That seems unnecessary, but sure, leave it then. Just address the video embedding.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, it will look like that in VSCode, do a ./build-docs-html.sh and mkdocs serve to view the site on your local.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Jeremy-Prior It looks like the above image on my local after build but it's working fine on the live site. So for now I will update the video links on my local and will check once it merges.

Copy link
Contributor

Choose a reason for hiding this comment

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

It should look like this when you do a mkdocs serve from your end:

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay I will make it like that thanks


* **Introduction to key FBIS components:**

[![Dummy Image](./img/help-img-2.png)](https://www.youtube.com/watch?v=aex5tzLNWAo)
Copy link
Contributor

Choose a reason for hiding this comment

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

We are able to embed videos using the mkdocs-video plugin using ![type:video](video_url.com).

docs/src/user/manual/index.md Outdated Show resolved Hide resolved
docs/src/user/manual/index.md Outdated Show resolved Hide resolved
docs/src/user/manual/logout.md Outdated Show resolved Hide resolved
docs/src/user/manual/sign-up.md Outdated Show resolved Hide resolved
ketankartoza and others added 2 commits December 5, 2024 11:22
Copy link
Contributor

@Jeremy-Prior Jeremy-Prior left a comment

Choose a reason for hiding this comment

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

LGTM

@Jeremy-Prior Jeremy-Prior merged commit a81cd64 into main Dec 5, 2024
@Jeremy-Prior Jeremy-Prior deleted the registration-doc branch December 5, 2024 12:36
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

Successfully merging this pull request may close these issues.

2 participants