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

mkdocs setup #198

Closed
wants to merge 1 commit into from
Closed

mkdocs setup #198

wants to merge 1 commit into from

Conversation

melissawm
Copy link
Collaborator

Will allow local documentation set up with mkdocs serve --clean

Also fixes a few broken links resulting from the documentation restructure.

@melissawm melissawm changed the title Draft of mkdocs setup mkdocs setup Apr 17, 2024
@melissawm melissawm marked this pull request as draft April 17, 2024 16:28
Will allow local documentation set up with mkdocs serve --clean

Signed-off-by: Melissa Weber Mendonça <melissawm@gmail.com>
robambalu
robambalu previously approved these changes Apr 19, 2024
Copy link
Member

@timkpaine timkpaine left a comment

Choose a reason for hiding this comment

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

Hey, this breaks the wiki so I don't think it was tested (I don't see a wiki on your fork).

Here is an example on my fork: https://github.com/timkpaine/csp/wiki

Click e.g. "Install csp" and you'll see the linking is now broken.
Screenshot 2024-04-19 at 11 06 15

@melissawm
Copy link
Collaborator Author

Thanks for letting me know @timkpaine , this is still in draft as I figure out these issues, I'll make sure to fix. Cheers!

@timkpaine timkpaine added part: documentation Improvements/bugs/changes to documentation type: feature Issues and PRs related to new features tag: internal Issues and PRs for maintainance of the project - not interesting to external users labels May 6, 2024
@timkpaine
Copy link
Member

Closing as stale, we can revisit down the road

@timkpaine timkpaine closed this Jul 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: documentation Improvements/bugs/changes to documentation tag: internal Issues and PRs for maintainance of the project - not interesting to external users type: feature Issues and PRs related to new features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants