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

WIP: New layout #1026

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

WIP: New layout #1026

wants to merge 15 commits into from

Conversation

OsirisTerje
Copy link
Member

@OsirisTerje OsirisTerje commented Mar 8, 2025

Experimental stuff for now

landing page, step 1

See discussion #1023

@SeanKilleen
Copy link
Member

Please look into linking an HTML file into docfx rather than putting HTML into markdown files.

@OsirisTerje
Copy link
Member Author

I am just experimenting......

Copy link

github-actions bot commented Mar 8, 2025

@OsirisTerje
Copy link
Member Author

OsirisTerje commented Mar 8, 2025

Could do this locally perhaps. but then i need to figure out how this container stuff works. Got all docker set up though, so...

I am "sleepless in Queensland".... so just thought, why not... and since my knowledge of css and style is close to nada, then... what can possibly go wrong...

But I got a kind of first try up now :-) Not bad for a newbie!

@SeanKilleen
Copy link
Member

@OsirisTerje no problem doing it here. Just suggesting parameters for the experiment. I can clean it up at the end if needed 👍.

If you want to do it locally easily, you can do that too.

  • Open in VS Code
  • Choose to open dev container

Everything will be set up just like it is in a GitHub Codespace. You can run "build", "serve", "lint", etc.

@OsirisTerje
Copy link
Member Author

OsirisTerje commented Mar 8, 2025

Do I get the preview too?

Just suggesting parameters for the experiment

Meaning ?

@SeanKilleen
Copy link
Member

SeanKilleen commented Mar 8, 2025

Yes you get the preview too 👍 running serve does it. https://github.com/nunit/docs?tab=readme-ov-file#how-to-build-these-docs-within-github-codespaces-or-a-dev-container (works In codespace too so you don't even have to do it locally)

My meaning was just that part of the experiment should be validating that docfx can serve HTML in the way we want. But I can handle that part of the experiment later if you want. 👍 Wouldn't want to have a markdown file filled with HTML.

@OsirisTerje
Copy link
Member Author

OsirisTerje commented Mar 8, 2025

Sure.
When trying locally, I start the DevContainer, asking for which folder, so I choose 1) The devcontainer folder and when not working, try again, now 2) the docs folder. In both cases it asks me where to put the configuration file, but that is already present right ?

PS: The reason I just used the md file is that it was there already, I then didnt have to figure out config etc.....but ofc, you fix later :-) If this works out, that is. There might be some redirect issues, I think. We need to move things into new folders, and then a lot is lost wrt to links. So, either redirect or just not, let it just be new...

@SeanKilleen
Copy link
Member

I will do a video tutorial. I pull the code, click the button in the lower left-hand corner or choose "reopen in container" and then once it loads it's ready to go.

@OsirisTerje
Copy link
Member Author

image
Which button ?

@OsirisTerje
Copy link
Member Author

OsirisTerje commented Mar 8, 2025

The leftmost violet thing did open up that choice, but it is now spinning up, 80% done, but this takes time.....
image

@SeanKilleen
Copy link
Member

You can either click the blue button in the lower left -hand corner, or you can open the VSCode command palette and look for "Reopen in container".

@OsirisTerje
Copy link
Member Author

The log shows a ton of commands, I assume this is a first thing only.....

@SeanKilleen
Copy link
Member

It takes time the first time. Because it is pulling and building a container for the first time that did not previously exist on your system.

@OsirisTerje
Copy link
Member Author

Yeah, it seems to be up now, but the Terminal is dead in the water:
image
I assume that is where I do the build, serve etc,...

I also see a lot of markdownlint errors popping up, I assume again that is just locally and wont happen with I run build... Whenever I get the terminal up and running

@OsirisTerje
Copy link
Member Author

OsirisTerje commented Mar 8, 2025

Started a new Terminal, and then I get it Live.

Now started Build, and it started a build, I assume it is the correct one. But hey, this is slow....

serve: that ran the build again, and I see it eats up my memory it was around 97%, killed a few others, now down to 80%. And I got 32G in this laptop

But YEAH, got it up now. I'll give this a spin and see how much I can get out of this.

@OsirisTerje OsirisTerje requested a review from SeanKilleen March 9, 2025 11:27
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